X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=README.md;h=a57c1c1eb48d01b17e118333a26f661b035dac63;hp=b541ddc2335ff88c5a165c5ea794ae36a49a166b;hb=2bb4666e276e837add0958554a11b38f7f4d9357;hpb=263eef68994fabff2855232e1955fddebb1a8860 diff --git a/README.md b/README.md index b541ddc2..a57c1c1e 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,8 @@ # 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. - -## 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 - -## 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/\*.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 +never seen elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" +in English. No ratings, no tournaments: no "competition spirit". ## Get involved @@ -43,6 +12,10 @@ 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. + +### Running the website locally + +Follow the instructions in server/README.md first, and then in client/README.md.