Flesh out README.md a bit

This commit is contained in:
Magnus Hoff 2017-09-25 15:41:14 +02:00
parent 8d7e1a6bb7
commit 85a4064d4c

View file

@ -12,4 +12,32 @@ version.
Install and run
===============
Sausagewiki aims to be simple to get up and running. It is distributed as a
single executable.
single independent executable for Linux.
1. Download the latest build of `sausagewiki.xz` from <https://github.com/maghoff/sausagewiki/releases/latest>
2. Decompress: `xz -d sausagewiki.xz`
3. Set execution permission: `chmod a+x sausagewiki`
4. Run: `./sausagewiki wiki.db`
For other platforms you will presently have to build it yourself. Sausagewiki
is built like other Rust projects, with `cargo build`.
Command line arguments
----------------------
USAGE:
sausagewiki [OPTIONS] <DATABASE>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-p, --port <port> Sets the listening port
ARGS:
<DATABASE> Sets the database file to use
Sausage will create an SQLite database file with the filename given in the
`DATABASE` parameter and open an HTTP server bound to `127.0.0.1` and the given
port number. The default port number is 8080.