Permalink
Browse files

Update instuctions

  • Loading branch information...
1 parent ec0afe4 commit 21fea42f3122cf847693104394ce0d9ece0ad6b0 @designgears designgears committed Jun 20, 2016
Showing with 8 additions and 10 deletions.
  1. +3 −3 README.md
  2. +5 −7 package.json
View
@@ -31,11 +31,11 @@ After cloning the repository run the following commands:
1. `npm install` _(downloads dependencies for the project from NPM and builds the project to the dist/ folder.)_
-2. `npm run getmaps` _(downloads the map files from Dropbox and extracts them properly, you only need to do this once.)_
+2. `grunt build` _(download & extracts map files, lints markup/js/css/json, creates vendor bundle, minifies js/css, builds the dist folder)_
-3. `npm start &` _(runs a local webserver listening on port 80 in the background. open a web browser and visit http://localhost)_
+3. `grunt server` _(runs a local webserver listening on port 80 in the background and watches files for changes. Open your web browser to http://localhost)_
-4. `npm run build:watch` _(watches the assets folder for changes and automatically runs the build task necessary to update the dist folder.)_
+Optional: `grunt rebuild` _(same thing as build but doesn't download the maps again.)_
Credits & Licence
--------------------------------------
View
@@ -4,19 +4,17 @@
"Setup Instructions:",
"--------",
"1. npm install",
- "2. npm run getmaps",
+ "2. grunt build",
"",
"--------",
"Development Instructions (no webserver needed!):",
"--------",
- "3. npm start &",
- "4. npm run build:watch",
+ "3. grunt server",
"",
"Open your web browser of choice and visit http://localhost.",
- "#1 installs npm dependencies for this project and builds the project to the dist/ folder.",
- "#2 grabs the maps from dropbox (only ever do this once).",
- "#3 runs a web server using node/express in background.",
- "#4 watches for changes to any files in the assets folder and if a change is detected, ",
+ "#1 installs npm dependencies for this project.",
+ "#2 builds the project to the dist/ folder.",
+ "#3 runs a web server using node/express in background. Watches for changes to any files in the assets folder and if a change is detected, ",
"the build task is executed immediately so the results are visible your browser."
],
"name": "witcher3map",

0 comments on commit 21fea42

Please sign in to comment.