README

   1 μBotany
   2 =======
   3
   4 μBotany is an experiment to see what can be done in gemini without
   5 employing client-side TLS certificates. In place of these, we rely on
   6 an account identifier (a SHA-1 hash of the account name and some
   7 random salt) transmitted in the query portion of the URI to uniquely
   8 specify accounts.  Because this identifier is difficult to guess from
   9 the account name, and because the URI is transmitted to the server
  10 over TLS, I don't think this is a _terrible_ way of managing sessions.
  11
  12 μBotany is inspired by (i.e. a flagrant ripoff of) Mozz's Astrobotany,
  13 which can be found at gemini://astrobotany.mozz.us/.  However, it's
  14 best thought of as a cut-down implementation of Jacob Funke's original
  15 Botany game, the source for which can be found at
  16 https://github.com/jifunks/botany.
  17
  18 All of the plant descriptions and ascii art have been copied directly
  19 from the original, while the logic has been entirely reimagined and
  20 implemented as Chicken Scheme extension scripts to my RAGS gemini
  21 server.
  22
  23 Installation
  24 ------------
  25
  26 To install and run μBotany you'll first need to be running the RAGS
  27 gemini server. (Source available at
  28 gopher://thelambdalab.xyz/1/scripts/browse-git%7Crags.git.)
  29 Then, simply move this directory to a directory named "microbotany" within the content
  30 root of your server.  You should then be able to create new gardens by
  31 visiting gemini://your.server/microbotany/.
  32
  33 Licence
  34 -------
  35
  36 μBotany is derived from Jacob Funke's Botany game, which he released
  37 under the ISC free software license.  Thus μBotany is also distributed
  38 under the same license, which can be found in the file named LICENSE.
  39