X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=README.md;h=c7ed328f0121d5a158f33d48f91f07fad95de2d2;hp=2178d172105ef99363c790132b85145dae0eeebf;hb=6b6ff7270af62639c24a05085b51bd07ef2e4d52;hpb=25ee546945f9343fe38beb6c20a0c1d95c9fee6c diff --git a/README.md b/README.md index 2178d172..c7ed328f 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,21 @@ # 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 +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... - - Your identity (if filled) is revealed only after the game +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, - - mini.css, - - Google font 'Open Sans' + a few icons, - -Sounds and 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 +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.