summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsitkevij <sitkevij@gmail.com>2019-01-01 22:10:00 -0800
committersitkevij <sitkevij@gmail.com>2019-01-01 22:10:00 -0800
commit72cd49201e6ad30d3891552633ef2bf814a39a33 (patch)
treeed4d52abd9a6c8ec6b329e3c38f1b84b39259fcd
parentddcbcae4ad97779612693a497fe22162e1fae2a6 (diff)
#6 0.1.3 enhancements, improve cli user feedback, Makefile, cargo fmt
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1b49629..1616939 100644
--- a/README.md
+++ b/README.md
@@ -36,12 +36,17 @@ $ hex -c12 tests/files/alphanumeric.txt
# install
-From within the `hex` source code directory, run:
+From within the `hex` source code directory, simply execute:
```
make install
```
-
-Using `cargo`, the above will compile the release version, run tests and install release binary to `<USERDIR>/.cargo/bin/hex`.
+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.