summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJan Wolff <janw@mailbox.org>2020-05-19 07:25:03 +0200
committerJan Wolff <janw@mailbox.org>2020-05-19 07:25:03 +0200
commitb6e428eba2397ab063f6580098fe100906c44fb1 (patch)
tree967a5c6a48bd8f10458250d57a0b5f5d014e78be /README.md
parent710e8aae565bd376d493ed89859c52d7f58a34f7 (diff)
more documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/README.md b/README.md
index 73023ea..ed6cd45 100644
--- a/README.md
+++ b/README.md
@@ -23,18 +23,36 @@ there is no way to disable this. Of course, Gemini's default port (1965) can be
opened in user-mode, but not changing the user after startup would retain read
permissions to the private key.
+Building
+--------
+
+Set up a Cargo build environment, then simply run
+```sh
+cargo build
+```
+to create a debug build or
+```sh
+cargo build --release
+```
+to create a release build.
+
Starting
--------
Sheldon Director look for a config file in `/etc/sheldond.conf`. If you want to
-change this, pass an alternative path on startup like so:
+change this, pass an alternative path on startup using the `-c` parameter.
+Use `-h` to get a list of all supported command line arguments.
-An example start can look like this:
-```sh
-sudo ./sheldond -c ./sheldond.conf
+An example config file can be found in this repository in `doc/sheldond.conf`.
+Use it to serve the content of the `doc/` directory on localhost:
```
+sudo ./target/debug/sheldond -c ./doc/sheldond.conf
+```
+Try connecting to `gemini://localhost` via your favorite Gemini client!
-An example config file can be found in this repository in `doc/sheldond.conf`.
+Note: This sets the user to `nobody` and the group to `nobody` as well. This
+naming scheme is not consistent for all Unix systems... Try changing the group
+name to `nogroup` if the software fails to start.
Why "Sheldon Director"?
-----------------------