summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-03-02 16:28:10 +0100
committerWojtek Kosior <koszko@koszko.org>2022-03-02 16:28:10 +0100
commitaee1aed7a37e2297b55d3495cfaeff81610c0137 (patch)
tree4ce8661a7f32031e6f699ca47cddc08ce375021f /README.md
parent4eb22719e43d1217a7629d5c4d82df7eafb24c68 (diff)
downloadhaketilo-hydrilla-aee1aed7a37e2297b55d3495cfaeff81610c0137.tar.gz
haketilo-hydrilla-aee1aed7a37e2297b55d3495cfaeff81610c0137.zip
refer to other sources for more information about running Hydrilla
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index e63e1a6..3f6cbac 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,7 @@ python3 -m pytest
### Hydrilla command
-Hydrilla includes a `hydrilla` command that can be used to quickly and easily spawn a local instance, e.g.:
+Hydrilla includes a `hydrilla` shell command that can be used to quickly and easily spawn a local instance, e.g.:
```
hydrilla -m /path/to/where/package/files/to/serve/are/stored -p 10112
```
@@ -83,7 +83,17 @@ This will cause the resources from provided path to be served at [http://127.0.0
The actual packages to serve are made using [Hydrilla builder](https://git.koszko.org/hydrilla-builder/).
-*TODO...*
+For more information about available options, pass the `--help` flag to `hydrilla` command:
+``` shell
+hydrilla --help
+```
+
+If navigate your POSIX shell to Hydrilla sources directory, you can also consult the included manpage (`man` tool required):
+``` shell
+man ./doc/man/man1/hydrilla.1
+```
+
+Last but not least, you might find it useful to consult the default, internal configuration file of Hydrilla that resides under `src/hydrilla/server/config.json` in the sources repository.
## Copying