X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=README.md;h=b541ddc2335ff88c5a165c5ea794ae36a49a166b;hp=c5cb508172863767d8574543b9de5d0636e057d9;hb=263eef68994fabff2855232e1955fddebb1a8860;hpb=ba8255cae2a684709d4d1d4427677b3cab8f8c8b diff --git a/README.md b/README.md index c5cb5081..b541ddc2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # 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 @@ -10,6 +11,7 @@ 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 ## Resources @@ -19,15 +21,28 @@ Server side: Client side: - Vue.js, - - underscore.js (TODO: remove this dependency), + - underscore.js, - mini.css, - Google font 'Open Sans' + a few icons, -Pieces images where found at various locations. +Sounds and 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 + 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 + +## Get involved + +All contributions are welcome! For example, + - translations, + - design, + - 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 feel comfortable with the code a pull request is a good start too.