commit bb377d6f0aa3985a9f85d4fcabf9862dbd7e1d44
parent 3908a24b94a8319a6df07598647c6007fd4c2826
Author: Natalie Pendragon <natpen@natpen.net>
Date: Sat, 30 Jan 2021 07:15:18 -0800
Make README heading lines more consistent
Diffstat:
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -19,24 +19,24 @@ sandboxed to avoid indexing huge parts of the gemini space.
Now you'll have created `index.new` directory, rename it to `index`.
-# Running the frontend
+## Running the frontend
1. Run: `poetry run serve`
2. Navigate your gemini client to: "gemini://localhost/"
-## automatic frontend with systemd-unit
+### Running the frontend in production with systemd
1. update `infra/gus.service` to match your needs (directory, user)
2. copy `infra/gus.service` to `/etc/systemd/system/`
3. run `systemctl enable gus` and `systemctl start gus`
-# Updating the index
+## Running the crawl to update the index
1. Run: `poetry run crawl`
2. Run: `poetry run build_index`
3. Restart frontend
-## systemd-unit for crawling
+### Running the crawl in production with systemd
1. update `infra/gus-crawl.service` to match your needs (directory, user)
2. update `infra/gus-crawl.timer` to match your needs (OnCalendar definition)
@@ -44,7 +44,7 @@ Now you'll have created `index.new` directory, rename it to `index`.
4. run `systemctl enable gus-crawl.timer` & `systemctl start gus-crawl.timer` to start the timer
-## Running test suite
+## Running the test suite
Run: `poetry run pytest`
