diff options
| author | jakobst1n <jakob.stendahl@outlook.com> | 2024-06-12 01:53:12 +0200 |
|---|---|---|
| committer | jakobst1n <jakob.stendahl@outlook.com> | 2024-06-12 01:53:12 +0200 |
| commit | 7952fd2ecd3eeb1d1b923319339ddff8eaad8a03 (patch) | |
| tree | adcbbf333a6ae96987458c5499ec0546bb7dd7eb | |
| parent | 29e5f0102073462d300be8458240c9699d403d55 (diff) | |
| download | textgraph-7952fd2ecd3eeb1d1b923319339ddff8eaad8a03.tar.gz textgraph-7952fd2ecd3eeb1d1b923319339ddff8eaad8a03.zip | |
Add a very simple usage section to readme
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -13,6 +13,19 @@ The documentation is in the manual file `tg.1`. It is only tested with glibc and terminals with ansi escape code support. +## Usage +You can compile it with `cargo build --release`, +there is also a script in `packaging` which can be used to make a `.deb`. +If you are on a debian based distro, you should be able to run `./packaging/package-debian.sh`. +Then a `textgraph.deb` file should be made somewhere in `/tmp/`. + +There is a spec file for rpms as well, but I haven't gotten around to making a script to build for that. + +If you compile with `cargo build --release`, you can copy it to your path, e.g. +``` +sudo install target/release/textgraph /usr/local/bin/tg +sudo install tg.1 /usr/share/man/man1/tg.1 +``` ## Example 1 Some examples of the different modes, from the same input file with random numbers |