diff options
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c88391 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +raidgrep +======== + +A tool for searching your local 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` + + +Usage +----- + +View the help message with `raidgrep --help`. + +License +------- + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. |