X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=client%2FREADME.md;h=2c1caabd87a49134d1fee2f2fac00aa12e6efb77;hp=0b7fbe4f5eb95c99303362b31ea785d036cf8b3e;hb=e07981727a6d486886f01f8e0ddc548fd733764b;hpb=625022fdcf750f0aff8fcd699f7e9b89730e1d10 diff --git a/client/README.md b/client/README.md index 0b7fbe4f..2c1caabd 100644 --- a/client/README.md +++ b/client/README.md @@ -1,34 +1,46 @@ # vchess-client ## Project setup -Rename and edit src/socket\_url.js.dist into socket\_url.js + +Rename and edit src/parameters.js.dist into parameters.js. Then, +download the folders and files listed in download\_objects file. +(This is optional, most variants will work without it). + +For Emergo and Avalam, run generateSVG\*.py scripts in folder +public/images/pieces/Emergo and Avalam (pieces SVGs). + +Finally install dependencies. ``` npm install ``` ### Compiles and hot-reloads for development + ``` npm run serve ``` ### Compiles and minifies for production + ``` npm run build ``` ### Lints and fixes files + ``` npm run lint ``` ### Customize configuration + See [Configuration Reference](https://cli.vuejs.org/config/). ## Resources - - Vue.js + Vue router, - - Underscore.js, - - mini.css, - - Google font 'Open Sans' + a few icons, +- Vue.js + Vue router, +- Webpack, +- mini.css Sounds and pieces images where found at various locations. +Fonts were found on Google Fonts.