commit d8fc5a1bec0f0e9d8eac3fad141aa96dddf3385f
parent a3dd4578b051bf55728b9c250844287992b43792
Author: Natalie Pendragon <natpen@natpen.net>
Date: Thu, 18 Jun 2020 07:16:13 -0400
Update README
Diffstat:
1 file changed, 3 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,23 +1,6 @@
-# Developer Quickstart
+# Gemini Universal Search (GUS)
-Note that doing this currently requires you to perform a
-full crawl of Geminispace. With little content, and few
-people hacking on this, it's probably fine, but we should
-definitely keep tabs on this to ensure we're kind and
-respectful to content and server owners (I think the
-solution is that we need a way to create a mock index
-sooner than later).
-
-1. Get Python and [Poetry](https://python-poetry.org/docs/)
-2. Generate a local Geminispace index with `poetry run crawl --destructive`
-3. Serve GUS locally with `poetry run serve`
-
-At this point you should be able to interact with a running
-local version of GUS, modulo perhaps some mucking about with
-SSL (which is left as an exercise to the reader because I am
-not an expert at all in that stuff :).
-
-# Contributing
+## Contributing
Please send patches to [~natpen/gus@lists.sr.ht](mailto:~natpen/gus@lists.sr.ht).
@@ -25,7 +8,7 @@ For an introduction to mailing list-based Git collaboration,
see [this introduction](https://git-send-email.io/), as well
as this guide to [mailing list etiquette](https://man.sr.ht/lists.sr.ht/etiquette.md).
-# Roadmap / TODOs
+## Roadmap / TODOs
- **log output of crawl**: I see some errors fly by, and it
would be nice to be able to review later and investigate.
