geminispace.info

Unnamed repository; edit this file 'description' to name the repository.
git clone git://code.clttr.info/geminispace.info.git
Log | Files | Refs | README | LICENSE

commit fd3a662f11bf8d1c1a52332951984ada1487c507
parent f132b6513725aa76ca3b3884923bb5530ee5c92f
Author: Natalie Pendragon <natpen@natpen.net>
Date:   Thu, 27 Feb 2020 09:06:38 -0500

Update README

Diffstat:
AREADME.md | 24++++++++++++++++++++++++
DREADME.txt | 19-------------------
2 files changed, 24 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md @@ -0,0 +1,24 @@ +# Developer Quickstart + +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. + +1. Get Python and [Poetry](https://python-poetry.org/docs/) +2. Generate a local Geminispace index with `poetry run crawl` +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 + +Please send patches to [~natpen/gus@lists.sr.ht](mailto:~natpen/gus@lists.sr.ht). + +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). diff --git a/README.txt b/README.txt @@ -1,19 +0,0 @@ -Developer Quickstart --------------------- - -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. - -1. Get Python and Poetry[1] -2. Generate a local Geminispace index with - `poetry run crawl` -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 :).