--- a/README.md Thu Oct 19 15:10:12 2023 -0500 +++ b/README.md Thu Oct 19 15:35:05 2023 -0500 @@ -6,11 +6,14 @@ ## Installation and usage 1. Install [Rust](https://www.rust-lang.org) following instructions. -2. Run `cargo build` to compile the program (optional; the next step does it if needed). -3. To process a document, use +2. To compile and install the program (typically in `~/.cargo/bin/`), run + ``` + cargo install --path=. ``` - cargo run < input.tex > output.tex + If you would prefer just building or running the program without installing, use `cargo build` or `cargo run`. +4. To process a document, use ``` - You may also find the built binary under `target/debug/strip-changes-markup`, and copy it to a place that works for you, instead of using `cargo` to run the program. + strip-change-markup input.tex -o output.tex + ``` - \ No newline at end of file +For further options, such as whitespace and comment stripping, use the `--help` argument (`cargo run -- --help` when running through `cargo` without installing).