Skip to content

Commit e267807

Browse files
Installation Guide updated in Readme (#138)
* Installation Guide updated in Readme * Installation section * Installation section * Installation Guide Co-authored-by: [UNNATI] <chhabraunnati234@gmail.com>
1 parent f9cdf00 commit e267807

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,38 @@ After installing node and npm run `npm install` from the root directory.
6363

6464
Make changes to the files in the `/src/` directory, then run `grunt build` to compile into `/dist/inlineMarkdownEditor.js`. This will use `grunt-browserify` to concatenate and include any node modules named in `require()` statements. You'll then be able to try it out in `/examples/index.html`. Run `grunt` and leave it running to build as you go.
6565

66+
## Installation Guide
67+
68+
### Pre-requisites
69+
* A Laptop :)
70+
* NodeJS
71+
72+
- Install [NodeJS](https://nodejs.org).
73+
74+
- Instructions for installing node and npm available in the [documentation](https://nodejs.org/en/docs/).
75+
76+
- After installing nodejs, then comes running and installation of Grunt.
77+
- Use this command
78+
- npm run `npm install` from root directory :)
79+
80+
This repository `inline-markdown-editor` uses grunt - the JavaScript task runner - for compilation of the modules.
81+
82+
- Grunt is a JavaScript task runner, a tool used to automatically perform frequent tasks such as minification, compilation, unit testing, and linting. It uses a command-line interface to run custom tasks defined in a file (known as a Gruntfile). Grunt was created by Ben Alman and is written in Node.js. It is distributed via npm. As of September 2016, there were more than 5,000 plugins available in the Grunt ecosystem.
83+
84+
### Grunt Installation
85+
86+
- To install grunt run `npm install -g grunt-cli`. You may have to use `sudo` for root privileges.
87+
- Make changes to the files in the `/src/` directory.
88+
- Run `grunt build` to compile into `/dist/inlineMarkdownEditor.js`.
89+
- This will use `grunt-browserify` to concatenate and include any node modules named in `require()` statements.
90+
- You can try out in `/examples/index.html`.
91+
- Run `grunt`.
92+
- You are all set. Happy contributing :)
93+
94+
95+
96+
97+
6698
## Tests
6799

68100
Tests are set up with Jasmine, and can be run with `npm test`.

0 commit comments

Comments
 (0)