Skip to content

Commit

Permalink
📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JAGFx committed Apr 26, 2020
1 parent b26a791 commit 9f514aa
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 12 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -160,6 +167,10 @@ Start the production version of the server
````bash
$ npm run server:start
````
OR
````bash
$ npm start
````

#### Build

Expand All @@ -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
Expand All @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion doc/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@
"private": false,
"description": "Euro Truck Simulator 2 dashboard",
"author": "Emmanuel SMITH <[email protected]> (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": {
Expand Down

0 comments on commit 9f514aa

Please sign in to comment.