commit e054084bcc29edfcff4c1c2645649edbc666d2e0 (patch)
Author: Alex Karle <email@example.com>
Date: Thu, 30 Apr 2020 19:47:19 -0400
doc: Update README
The release of sourcehut projects and the recent licensing under MIT
makes it a good time to update the README for a more detailed
description, both in terms of what it is and how to use it.
|M||README.md|| | ||48||++++++++++++++++++++++++++++++++++++++++++++----|
1 file changed, 44 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -3,22 +3,62 @@ euchre.live
For my family <3
-Euchre is our "family game", and with the COVID-19 social-distancing, we're
-suddenly unable to play.
+Euchre is a card game. It is our "family game", frequently played at family
+reunions due to its ability to both engage players and be a game you can sit
+back and chat over without thinking too much.
+With the COVID-19 social-distancing, we're suddenly unable to play, so we
+started to look at options to play online.
Disappointed with the state of the online options, we decided to make our own.
+The production version is playable now at [euchre.live](http://euchre.live), but
+the code is all free under the MIT license, so feel free to hack it or host your
-Install `npm`, `cpanminus`, and Perl. Then:
+* Perl (tested on 5.30, but should be pretty portable)
+* Node (tested on 12.15.0, no idea how portable)
+### Getting the Dependencies
$ npm i
$ cpanm --installdeps .
+### Building the Release
+The release version is a subset of the repo, built into a separate directory
+for easier deployment.
+### Running the Server
+$ ./build/gloat.pl daemon
+Use [run.sh](./run.sh) to run the server with webpack watching the files
+for incremental rebuilding (while hacking).
+This is not how it is run in production, as the overhead of webpack is quite