Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nualn committed May 13, 2023
1 parent 36d6cff commit e03ee48
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The tests are written in the same file as the code they test. This is a conventi
## Inputs
The tests are run with both small and large inputs. The small inputs are used to test the correctness of the program. The large inputs are equivalent to the inputs that the program is expected to handle in practice.
## Running
Run ```cargo test``` in the terminal
Run ```cargo test``` in the terminal in the root directory of the project source.

**Note!**

Expand Down
3 changes: 3 additions & 0 deletions documentation/usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Usage

You can download the program from the from the release page as a precompiled binary for Linux or Windows or you can compile the program yourself by cloning the repository and running `cargo build --release` in the root directory of the project source.

The program can be run with the following commands:

Expand Down

0 comments on commit e03ee48

Please sign in to comment.