Garmelon/tablejohn
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document building instructions

Browse source
This commit is contained in:
Joscha 2023-08-04 14:46:56 +02:00
parent 037f076475
commit 6d6e25f991
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -2,6 +2,20 @@
A tool to run benchmarks for a git repo and display their results. A tool to run benchmarks for a git repo and display their results.
## Building from source
The following tools are required:
- `cargo` and `rustc` (best installed via [rustup](https://rustup.rs/))
- `tsc`, the [typescript](https://www.typescriptlang.org/) compiler
For developing, the following tool is additionally required:
- `sqlx`, the [CLI of the sqlx library](https://github.com/launchbadge/sqlx/blob/main/sqlx-cli/README.md)
Once you have installed these tools, run `cargo build --release`.
The compiled binary will be located at `target/release/tablejohn`.
It contains everything needed to run tablejohn.
No additional files are required.
## Design notes ## Design notes
- A tablejohn instance tracks exactly one git repository. - A tablejohn instance tracks exactly one git repository.