diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -34,6 +34,22 @@ $ hex -c12 tests/files/alphanumeric.txt ![octal hex output format](https://raw.githubusercontent.com/sitkevij/hex/master/tests/files/hex_screenshot_macos_format_o.png) +# install + +From within the `hex` source code directory, simply execute: +``` +make install +``` +This will run the followng `cargo` commands: +``` +cargo build --release +cargo test --verbose --all -- --nocapture +cargo install --path . +``` +Which will compile the release version, run tests and install release binary to `<USERDIR>/.cargo/bin/hex`. + +If `<USERDIR>/.cargo/bin` is part of the `PATH` evironment variable, `hex` should be able to be executed anywhere in the shell. + # feature: output arrays in rust, c or golang `hex` has a feature which can output the input file bytes as source code arrays. |