Remove extra log file...
[vchess.git] / README.md
index 3147c1f..bedce32 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +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.
 
-## Usage
+Notes:
+ - Games start with a random assymetric position!
+ - No ratings, no tournaments: no "competition spirit"
 
-I hope it's intuitive enough :)
+## Get involved
 
-But, a few important points:
- - All games start with a random assymetric position!
- - Games are untimed: you decide to play fast or not...
+All contributions are welcome! For example,
+ - translations,
+ - design,
+ - Vue front-end,
+ - Express back-end.
 
-## Resources
-
-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. Rename public/javascripts/utils/socket\_url.js.dist into socket\_url.js
-    and adjust its content.
- 2. git fat init && git fat pull
- 3. npm i && npm start
+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.