You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -29,13 +28,24 @@ To begin using this template, choose one of the following options to get started
29
28
30
29
### Basic Usage
31
30
32
-
After downloading, simply edit the HTML and CSS files included with the template in your favorite text editor to make changes. These are the only files you need to worry about, you can ignore everything else! To preview the changes you make to the code, you can open the `index.html` file in your web browser.
31
+
After downloading, simply edit the HTML and CSS files included with `dist` directory. These are the only files you need to worry about, you can ignore everything else! To preview the changes you make to the code, you can open the `index.html` file in your web browser.
33
32
34
33
### Advanced Usage
35
34
36
-
After installation, run `npm install` and then run `npm start` which will open up a preview of the template in your default browser, watch for changes to core template files, and live reload the browser when changes are saved. You can view the `gulpfile.js`to see which tasks are included with the dev environment.
35
+
Clone the source files of the theme and navigate into the theme's root directory. Run `npm install` and then run `npm start` which will open up a preview of the template in your default browser, watch for changes to core template files, and live reload the browser when changes are saved. You can view the `package.json` file to see which scripts are included.
37
36
38
-
You must have npm and Gulp installed globally on your machine in order to use these features.
37
+
#### npm Scripts
38
+
39
+
*`npm run build` builds the project - this builds assets, HTML, JS, and CSS into `dist`
40
+
*`npm run build:assets` copies the files in the `src/assets/` directory into `dist`
41
+
*`npm run build:pug` compiles the Pug located in the `src/pug/` directory into `dist`
42
+
*`npm run build:scripts` brings the `src/js/scripts.js` file into `dist`
43
+
*`npm run build:scss` compiles the SCSS files located in the `src/scss/` directory into `dist`
44
+
*`npm run clean` deletes the `dist` directory to prepare for rebuilding the project
45
+
*`npm run start:debug` runs the project in debug mode
46
+
*`npm start` or `npm run start` runs the project, launches a live preview in your default browser, and watches for changes made to files in `src`
47
+
48
+
You must have npm installed in order to use this build environment.
39
49
40
50
## Bugs and Issues
41
51
@@ -58,4 +68,4 @@ Start Bootstrap is based on the [Bootstrap](https://getbootstrap.com/) framework
58
68
59
69
## Copyright and License
60
70
61
-
Copyright 2013-2020 Start Bootstrap LLC. Code released under the [MIT](https://github.com/StartBootstrap/startbootstrap-simple-sidebar/blob/gh-pages/LICENSE) license.
71
+
Copyright 2013-2021 Start Bootstrap LLC. Code released under the [MIT](https://github.com/StartBootstrap/startbootstrap-simple-sidebar/blob/master/LICENSE) license.
0 commit comments