Add Castle Chess

[vchess.git] / README.md

diff --git a/README.md b/README.md
index 59af28d..a57c1c1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,35 +1,21 @@
 # v[ariant]chess.club
 
-Website to play to many chess variants, including rare ones - some almost never seens
-elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" in english.
+Website to play to many chess variants, including rare ones - some almost
+never seen elsewhere, like "l'Échiqueté" [french], renamed "checkered chess"
+in English. No ratings, no tournaments: no "competition spirit".
 
-## Usage
+## Get involved
 
-I hope it's intuitive enough :)
+All contributions are welcome! For example,
+ - translations,
+ - design,
+ - Vue front-end,
+ - Express back-end.
 
-But, a few important points:
- - All games start with a random assymetric position!
- - Games are untimed: you decide to play fast or not...
+If you wanna help, you can contact me with the form on the website,
+so that we can discuss what to do and how :)
+If you feel comfortable with the code a pull request is a good start too.
 
-## Resources
+### Running the website locally
 
-Server side:
- - node,
- - npm packages (see package.json),
-
-Client side:
- - Vue.js,
- - underscore.js (TODO: remove this dependency),
- - mini.css,
- - Google font 'Open Sans' + a few icons,
-
-Pieces images where found at various locations.
-
-## Installation (for developers)
-
- 0. Install git-fat https://github.com/jedbrown/git-fat
- 1. git fat init && git fat pull
- 2. Execute db/create.sql script (SQLite) to fill db/vchess.sqlite database
- 3. Rename public/javascripts/socket\_url.js.dist into socket\url.js
-    and adjust its content.
- 4. npm i && npm start
+Follow the instructions in server/README.md first, and then in client/README.md.