diff options
| author | Daniel <kingdread@gmx.de> | 2020-05-03 12:34:55 +0200 |
|---|---|---|
| committer | Daniel <kingdread@gmx.de> | 2020-05-03 12:34:55 +0200 |
| commit | 42b0559ec80beb24fec2f783b5503a59a615ccb3 (patch) | |
| tree | c02bad3ab958954ed4e4b386b7974f890340ddaa /README.md | |
| parent | 9fa6558e71a86e5a58445f1967025ac3511abe86 (diff) | |
| download | raidgrep-42b0559ec80beb24fec2f783b5503a59a615ccb3.tar.gz raidgrep-42b0559ec80beb24fec2f783b5503a59a615ccb3.tar.bz2 raidgrep-42b0559ec80beb24fec2f783b5503a59a615ccb3.zip | |
update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 30 insertions, 12 deletions
@@ -1,29 +1,47 @@ raidgrep ======== -A tool for searching your local raid & fractal log files. +A tool for searching your local Guild Wars 2/arcdps raid & fractal log files. Building -------- -* init `evtclib` submodule: `git submodule init && git submodule update` -* compilation: - * debug build for developers: `cargo build` (warning: the resulting binary is slow!) - * release build: `cargo build --release` -* cargo takes care of everything for you, so sit back and wait -* binary will be in `./target` - * debug binary: `./target/debug/raidgrep` - * release binary: `./target/release/raidgrep` +**raidgrep currently requires a nightly compiler** due to the `trait_alias` +feature! + +* Compilation: + * Debug build for developers: `cargo +nightly build` (warning: the resulting + binary is slow!) + * Release build: `cargo +nightly build --release` +* The build process can take a few minutes, as compiling + [LALRPOP](https://github.com/lalrpop/lalrpop) and link-time-optimization will + take a bit. +* The binary will be in `./target` + * Debug binary: `./target/debug/raidgrep` + * Release binary: `./target/release/raidgrep` ### Binaries -For now, can be found at https://kingdread.de/raidgrep/, updated with some -undefined frequency. +Pre-compiled binaries for each release can be found at +https://kingdread.de/raidgrep or alternatively attached to the [Gitlab +releases](https://gitlab.com/dunj3/raidgrep/-/releases). + +### Packages + +* Arch Linux (pre-compiled package): + [`raidgrep-bin`](https://aur.archlinux.org/packages/raidgrep-bin) +* Arch Linux (git package): + [`raidgrep-git`](https://aur.archlinux.org/packages/raidgrep-git) Usage ----- -View the help message with `raidgrep --help`. +You can view the help message with `raidgrep --help`. + +A manpage containing more information is available in +[raidgrep.1.asciidoc](raidgrep.1.asciidoc). You can convert it to the manpage +format by running `a2x -f manpage raidgrep.1.asciidoc` or to a HTML version by +running `asciidoc raidgrep.1.asciidoc`. License ------- |