update readme
This commit is contained in:
parent
69055bf5ce
commit
9bc85ca669
15
README.md
15
README.md
|
@ -1,23 +1,19 @@
|
|||
October CMS Webpack Theme Boilerplate
|
||||
==========
|
||||
|
||||
This is an example theme for October CMS that includes:
|
||||
This is a starter theme for October CMS that includes:
|
||||
|
||||
- Webpack (using Laravel Mix)
|
||||
- PostCSS
|
||||
|
||||
To use it:
|
||||
|
||||
- [Install October CMS](https://octobercms.com/docs/setup/installation)
|
||||
- Create a new folder in October /themes folder (call it for example my-awesome-theme)
|
||||
- Clone the repo in your theme folder
|
||||
- Activate the theme from October backend settings
|
||||
|
||||
To modify it:
|
||||
|
||||
- Open a terminal, go to your theme folder and run `npm install` (node_modules folder will be created)
|
||||
- Clone the repo in your theme directory
|
||||
- Inside cloned directory run `npm install` (node_modules folder will be created)
|
||||
- Install more packages using `npm install --save`
|
||||
- Require your installed packages in src/js/app.js
|
||||
- Modify the js and scss files
|
||||
- Modify the js and css files
|
||||
- Run `npm run dev` (`npm run watch` to recompile when something changes)
|
||||
- [Add new pages, partials, content files...](https://octobercms.com/docs/cms/themes)
|
||||
|
||||
|
@ -25,7 +21,6 @@ When you are ready for production:
|
|||
|
||||
- Run `npm run prod`
|
||||
|
||||
|
||||
## To add ajax framework
|
||||
|
||||
```sh
|
||||
|
|
Loading…
Reference in New Issue