Fix README
[vchess.git] / README.md
CommitLineData
1d184b4c
BA
1# v[ariant]chess.club
2
25ee5469 3Website to play to many chess variants, including rare ones - some almost never seen
1d184b4c
BA
4elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" in english.
5
6## Usage
7
8I hope it's intuitive enough :)
9
10But, a few important points:
11 - All games start with a random assymetric position!
12 - Games are untimed: you decide to play fast or not...
25ee5469 13 - Your identity (if filled) is revealed only after the game
1d184b4c
BA
14
15## Resources
16
17Server side:
ba8255ca
BA
18 - node,
19 - npm packages (see package.json),
1d184b4c
BA
20
21Client side:
22 - Vue.js,
25ee5469 23 - underscore.js,
1d184b4c
BA
24 - mini.css,
25 - Google font 'Open Sans' + a few icons,
26
25ee5469 27Sounds and pieces images where found at various locations.
1d184b4c
BA
28
29## Installation (for developers)
30
31 0. Install git-fat https://github.com/jedbrown/git-fat
a48ee8b8
BA
32 1. git fat init && git fat pull
33 2. Execute db/create.sql script (SQLite) to fill db/vchess.sqlite database
25ee5469 34 3. Rename public/javascripts/socket\_url.js.dist into socket\_url.js
92342261 35 and adjust its content.
05e400d3 36 4. npm i && npm start