Add Castle Chess

[vchess.git] / server / README.md

diff --git a/server/README.md b/server/README.md
index 8fa2642..ebcaf77 100644 (file)
--- a/server/README.md
+++ b/server/README.md
@@ -1,15 +1,34 @@
 # vchess-server
 
-## Resources
+Instructions to run the server locally.
 
- - Node.js,
- - Express,
- - Other npm packages (see package.json),
+## Requirements
 
-## Installation (for developers)
+- Node.js + npm (any recent version)
+- SQLite (version 3)
 
- 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 config/parameters.js.dist into parameters.js
- 4. npm i && npm start
+## Installation
+
+1. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
+
+```
+cd server/db
+sqlite3 vchess.sqlite
+sqlite> .read create.sql
+sqlite> .read populate.sql
+sqlite> .exit
+```
+
+2. Rename and edit `config/parameters.js.dist` into `config/parameters.js`
+
+3. Install npm modules
+
+```
+npm install
+```
+
+## Running
+
+```
+npm start
+```