mirror of https://github.com/ColorlibHQ/AdminLTE
Update README.md
parent
7cce06e902
commit
59b5f66d37
11
README.md
11
README.md
|
@ -26,23 +26,22 @@ SCSS has been used to increase code customizability.
|
||||||
To compile the dist files you need Node.js/npm, clone/download the repo then:
|
To compile the dist files you need Node.js/npm, clone/download the repo then:
|
||||||
|
|
||||||
1. `npm install` (install npm deps)
|
1. `npm install` (install npm deps)
|
||||||
2. `npm install gulp-cli -g` (install gulp-cli globally)
|
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
|
||||||
3. _Optional:_ `gulp` (developer mode, autocompile with browsersync support for live demo)
|
3. `npm run production` (compile css/js files)
|
||||||
4. `gulp compile` (compile css/js files)
|
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
- Highly welcome.
|
- Highly welcome.
|
||||||
- For your extra reference check [AdminLTE v3 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing)
|
- For your extra reference check [AdminLTE v4 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing)
|
||||||
- First thing first, you should have bit knowledge about NodeJS.
|
- First thing first, you should have bit knowledge about NodeJS.
|
||||||
- Github Knowledge.
|
- Github Knowledge.
|
||||||
- Install NodeJS LTS version.
|
- Install NodeJS LTS version.
|
||||||
- Clone this Repository to your machine.
|
- Clone this Repository to your machine and change to `v4-dev` branch.
|
||||||
- Go to Cloned Folder.
|
- Go to Cloned Folder.
|
||||||
- In cli/bash run `npm install` it will install dependency from `package.json`.
|
- In cli/bash run `npm install` it will install dependency from `package.json`.
|
||||||
- After installation complets, run `npm run dev`
|
- After installation complets, run `npm run dev`
|
||||||
- Cool, Send urs changes.
|
- Cool, Send urs changes in PR to `v4-dev` branch.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
Loading…
Reference in New Issue