From 9f514aa0aa721b75914860e3893b6e0425a606e1 Mon Sep 17 00:00:00 2001 From: JAGFx Date: Sun, 26 Apr 2020 14:36:44 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 35 +++++++++++++++++++++++++++++++---- doc/FEATURES.md | 2 +- package.json | 14 +++++++------- 3 files changed, 39 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7886b5e0..7cf5152d 100644 --- a/README.md +++ b/README.md @@ -84,10 +84,9 @@ $ cd ets2-dashboard-skin ### Build resources ````bash -$ npm i -$ cd server && npm i -$ npm rb -$ cd ../ && npm run build +$ npm i && npm rb +$ npm run server:install +$ npm run build ```` ## Features @@ -145,6 +144,14 @@ $ npm run dashboard:start ### Production +#### Server install + +Install all necessary dependencies for the server + +````bash +$ npm run server:install +```` + #### Server build Build the server dist files for the production @@ -160,6 +167,10 @@ Start the production version of the server ````bash $ npm run server:start ```` +OR +````bash +$ npm start +```` #### Build @@ -177,6 +188,14 @@ Generate a `*.tar.gz` archive with all production files of **Dashboard** and **S $ npm run bundle ```` +#### Build and Bundle + +Combine `Build` task and `Bundle` task + +````bash +$ npm run bAndB +```` + ### Other #### Font build @@ -189,6 +208,14 @@ To get more details, see [RESOURCES.md](doc/RESOURCES.md) $ npm run font:build ```` +#### ESLint + +Launch the lint inspector + +````bash +$ npm run lint +```` + ## License Under the [MIT License](LICENSE) diff --git a/doc/FEATURES.md b/doc/FEATURES.md index b3bfa7cb..631e2da7 100644 --- a/doc/FEATURES.md +++ b/doc/FEATURES.md @@ -45,7 +45,7 @@ All dada may not be displayed. See the [CONFIG_SETTINGS.md](CONFIG_SETTINGS.md) #### Others data -- Current gear selected +- Current gear selected (_With or not splitter indicator_) - Current speed - Engine RPM level - Fuel level diff --git a/package.json b/package.json index 0e586e8b..7cf3795e 100644 --- a/package.json +++ b/package.json @@ -4,19 +4,19 @@ "private": false, "description": "Euro Truck Simulator 2 dashboard", "author": "Emmanuel SMITH (https://emmanuel-smith.me)", - "scripts": { - "start" : "npm run server:start", - "build" : "npx gulp build", + "scripts": { "lint" : "vue-cli-service lint", - "bAndB" : "npx gulp bAndB", + "build" : "npx gulp build", "bundle" : "npx gulp bundle", - "dashboard:build" : "vue-cli-service build", + "bAndB" : "npx gulp bAndB", + "start" : "npm run server:start", "dashboard:dev" : "vue-cli-service serve", + "dashboard:build" : "vue-cli-service build", "dashboard:start" : "http-server dist/", - "font:build" : "npx gulp build:font", "server:install" : "cd server && npm i && npm rb", "server:build" : "cd server && npx gulp", - "server:start": "cd server && node ./dist/index.js" + "server:start" : "cd server && node ./dist/index.js", + "font:build" : "npx gulp build:font" }, "main": "index.js", "dependencies": {