X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=README.md;h=a0ea49de03c2073a0c0f9999448f42386b1420b0;hb=ae99d72ce4e0912f459b89059731563f5f20d34d;hp=ef7cbb23258116270cbe4fb2e754ff877331abda;hpb=c326e657d451c90220edbaa6f09fcb991350524c;p=vchess.git diff --git a/README.md b/README.md index ef7cbb23..a0ea49de 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,23 @@ # v[ariant]chess.club -Website to play to many chess variants, including rare ones - some almost never seen -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 - -I hope it's intuitive enough :) - -But, a few important points: - - All games start with a random assymetric position! - - Games are untimed: you decide to play fast or not... - - Your identity (if filled) is revealed only after the game +Notes: + - Games start with a random assymetric position! + - 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,4 +29,17 @@ 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 + +All contributions are welcome! For example, + - translations, + - design, + - Vue front-end, + - Express back-end. + +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.