Mercurial > repos > strip-changes-markup / file comparison
comparison: README.md
README.md
- changeset 3
- cec573b16b46
- parent 1
- a88aed2bdf13
- child 4
- 8082eb5a754b
equal
deleted
inserted
replaced
| 2:254e1e4bd795 | 3:cec573b16b46 |
|---|---|
| 4 This program removes [changes](https://www.ctan.org/pkg/changes) package markup from LaTeX documents. It was written because none of the existing regular expression based scripts actually worked on any sort of complex markup. This program (written in [Rust](https://www.rust-lang.org)) is not based on regular expressions, but has an actual semi-proper parser. | 4 This program removes [changes](https://www.ctan.org/pkg/changes) package markup from LaTeX documents. It was written because none of the existing regular expression based scripts actually worked on any sort of complex markup. This program (written in [Rust](https://www.rust-lang.org)) is not based on regular expressions, but has an actual semi-proper parser. |
| 5 | 5 |
| 6 ## Installation and usage | 6 ## Installation and usage |
| 7 | 7 |
| 8 1. Install [Rust](https://www.rust-lang.org) following instructions. | 8 1. Install [Rust](https://www.rust-lang.org) following instructions. |
| 9 2. Run `cargo build` to compile the program (optional; the next step does it if needed). | 9 2. To compile and install the program (typically in `~/.cargo/bin/`), run |
| 10 3. To process a document, use | |
| 11 ``` | 10 ``` |
| 12 cargo run < input.tex > output.tex | 11 cargo install --path=. |
| 13 ``` | 12 ``` |
| 14 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. | 13 If you would prefer just building or running the program without installing, use `cargo build` or `cargo run`. |
| 14 4. To process a document, use | |
| 15 ``` | |
| 16 strip-change-markup input.tex -o output.tex | |
| 17 ``` | |
| 15 | 18 |
| 16 | 19 For further options, such as whitespace and comment stripping, use the `--help` argument (`cargo run -- --help` when running through `cargo` without installing). |
