From: Benjamin Auder Date: Wed, 26 Dec 2018 21:58:56 +0000 (+0100) Subject: Fix README X-Git-Url: https://git.auder.net/%7B%7B%20asset%28%27mixstore/images/pieces/scripts/DESCRIPTION?a=commitdiff_plain;h=25ee546945f9343fe38beb6c20a0c1d95c9fee6c;p=vchess.git Fix README --- diff --git a/README.md b/README.md index 59af28d1..2178d172 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # v[ariant]chess.club -Website to play to many chess variants, including rare ones - some almost never seens +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 +10,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,17 +20,17 @@ 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. 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 + 3. Rename public/javascripts/socket\_url.js.dist into socket\_url.js and adjust its content. 4. npm i && npm start