Skip to content

Commit f9eafba

Browse files
committed
Updated the README.md with build steps.
1 parent 41c734e commit f9eafba

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ JavaScript Boilerplate is the collection of best practices using a design patter
66
## Files in Repository
77

88

9-
1. `src/index.html` - An html help file illustrating helper functions.
9+
1. `src/index.html` - An html help file illustrating helper functions.
1010

11-
2. `src/js/_config.js` - Config is having general details that will be commonly used across the application. Parameters like URLs, services, theme to be used within the application.
11+
2. `src/js/_config.js` - Config is having general details that will be commonly used across the application. Parameters like URLs, services, theme to be used within the application.
1212

13-
3. `src/js/_helper.js` - Helper utility functions that are required across different modules or even within a single module.
13+
3. `src/js/_helper.js` - Helper utility functions that are required across different modules or even within a single module.
1414

15-
4. `src/js/_main.js` - It defines the main module. We have used IIFE (Intermediately invoking function expression) namespacing and global abatement in this logic. MODULE is main namespace that has been defined and MODULE.helper is one of the components.
15+
4. `src/js/_main.js` - It defines the main module. We have used IIFE (Intermediately invoking function expression) namespacing and global abatement in this logic. MODULE is main namespace that has been defined and MODULE.helper is one of the components.
1616

17-
5. `src/css/style.css` - Style sheets for the html help file.
17+
5. `src/css/style.css` - Style sheets for the html help file.
1818

1919
## Usage
2020

@@ -63,6 +63,36 @@ You can also get the JavaScript Boilerplate through npm if you have already inst
6363

6464
npm install javascript-boilerplate
6565

66+
## Build Instructions
67+
68+
### We recommend using Grunt
69+
70+
Grunt - Download and Install [Grunt](http://gruntjs.com).
71+
72+
OR
73+
74+
Install Grunt
75+
76+
$ npm install grunt
77+
78+
You can also Install all the dependencies using
79+
80+
$ npm install
81+
82+
### Updating Grunt:
83+
```
84+
$ npm update -g grunt-cli
85+
```
86+
87+
### Build the Project using
88+
89+
$ grunt
90+
91+
You should see the below message for a successful build and a folder name `dist` has been created with all the expected output, parallel to `src` folder, with all the tasks completed.
92+
93+
Done, without errors.
94+
95+
6696
## Contributing
6797

6898
Anyone and everyone is welcome to [contribute](#).

0 commit comments

Comments
 (0)