X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=README.md;h=bedce325a4d3784962a83fd35af647b5baff9a70;hp=ef7cbb23258116270cbe4fb2e754ff877331abda;hb=0444d48e58a6700273fe4651490050962276295d;hpb=c326e657d451c90220edbaa6f09fcb991350524c diff --git a/README.md b/README.md index ef7cbb23..bedce325 100644 --- a/README.md +++ b/README.md @@ -1,35 +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/\*.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 +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.