docs: more fsf volunteer instructions
authorIan Kelling <iank@fsf.org>
Fri, 4 Feb 2022 04:57:46 +0000 (23:57 -0500)
committerIan Kelling <iank@fsf.org>
Fri, 4 Feb 2022 04:57:46 +0000 (23:57 -0500)
README.md

index a9db3806368f269e02497d5fff58c6f025fc7518..acf1f1b4dbc9997fa21ea5c004a7f8f5db811fab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,37 @@
+# LibreAdventure
+
 LibreAdventure is a fork of the last freely licensed version of
-WorkAdventure. As you can see below, renaming is incomplete.
+WorkAdventure, plus a map and small changes for use at LibrePlanet 2021.
+Renaming is incomplete.
+
+At FSF, we mainly want to fix a bug for LibrePlanet 2022
+(https://todo.sr.ht/~iank/libreadventure/1), and if we can find some
+other improvements to make that would be good too.
+
+There exists an instance of this code at play.libreadventure.org. You
+can try improvements there or locally. To get access, email
+<sysadmin@fsf.org> with your public ssh key and join #fsfsys and say
+that you've emailed your key and want to help with LibreAdventure. The
+FSF tech team will add your key to the server.  Before making changes to
+the server please say something on #fsfsys in order to coordinate with
+other volunteers. The main way to run the software is with `cd
+/srv/libreadventure-deployment; docker-compose restart`, then browse to
+https://play.libreadventure.fsf.org. The standard out of docker-compose
+is useful for development, so if multiple people are working on at the
+same time, you should do something to make it visible to multiple
+people, like sharing an tmux or screen, or redirecting it to a log file
+that can be tailed.
+
+Feel free to have a look at the upstream version of WorkAdventure and
+explore improvements made there. We should not copy any code because the
+upstream is under an incompatible license.
 
 This package is licensed AGPLv3. There is no indication in the repo of
 whether the original authors meant AGPLv3 or later or only. We are
 waiting to hear from them.
 
 
-# Work Adventure
+# Work Adventure (upstream readme is below)
 
 ## Work in progress