X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=README.md;h=8c2ec84886fe7cd702ba0987a1dc9fb569a22282;hp=2178d172105ef99363c790132b85145dae0eeebf;hb=8d7e2786f5a67a1b9a77c742d7951e0efbe8747d;hpb=25ee546945f9343fe38beb6c20a0c1d95c9fee6c diff --git a/README.md b/README.md index 2178d172..8c2ec848 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,19 @@ # 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), + - Express, + - Other npm packages (see package.json), Client side: - Vue.js, @@ -30,7 +27,19 @@ Sounds and pieces images where found at various locations. 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 + 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. Rename and edit utils/mailer.js.dist into mailer.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.