X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=README.md;h=a0ea49de03c2073a0c0f9999448f42386b1420b0;hb=ae99d72ce4e0912f459b89059731563f5f20d34d;hp=0b2d396be5e0083638c70b5e600e457d50a2759b;hpb=b6487fb9c41705187cf97215fc9e8f86a59057c7;p=vchess.git diff --git a/README.md b/README.md index 0b2d396b..a0ea49de 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,20 @@ 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 - -I hope it's intuitive enough :) - -But, a few important points: +Notes: - Games start with a random assymetric position! - - Your identity is revealed only after a game + - No ratings, no tournaments: no "competition spirit" ## Resources Server side: - - node, - - npm packages (see package.json), + - Node.js, + - Express, + - Other npm packages (see package.json), Client side: - Vue.js, - - underscore.js, + - Underscore.js, - mini.css, - Google font 'Open Sans' + a few icons, @@ -32,7 +29,8 @@ Sounds and pieces images where found at various locations. 1. git fat init && git fat pull 2. Execute db/\*.sql scripts to create and fill db/vchess.sqlite 3. Rename and edit public/javascripts/socket\_url.js.dist into socket\_url.js - 4. npm i && npm start + 4. Rename and edit config/parameters.js.dist into parameters.js + 5. npm i && npm start ## Get involved @@ -42,6 +40,6 @@ All contributions are welcome! For example, - Vue front-end, - Express back-end. -If you wanna help, you can send me an email (address indicated in the "Help" -menu on the website) so that we can discuss what to do and how :) +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.