Update readme for the new gulp and mbp build system
This commit is contained in:
42
README.md
42
README.md
@@ -3,33 +3,25 @@ Locomotive's Front-end Boilerplate
|
|||||||
|
|
||||||
Front-end boilerplate for projects by [Locomotive][locomtl].
|
Front-end boilerplate for projects by [Locomotive][locomtl].
|
||||||
|
|
||||||
## Requirements
|
## Installation
|
||||||
|
```sh
|
||||||
|
# install mbp and gulp
|
||||||
|
npm install mbp gulp@next -g
|
||||||
|
```
|
||||||
|
|
||||||
| Prerequisite | How to check | How to install |
|
## Usage
|
||||||
| --------------- | ------------- | -------------------------------- |
|
```sh
|
||||||
| Node.js 4.1.1 | `node -v` | [nodejs.org](https://nodejs.org) |
|
# init your project
|
||||||
| Grunt >= 0.1.13 | `grunt -v` | `npm install -g grunt-cli` |
|
mbp init locomotivemtl/shopify-boilerplate <directory>
|
||||||
|
|
||||||
## Getting started
|
# run default watch task
|
||||||
|
gulp
|
||||||
1. **Get the latest node modules**
|
```
|
||||||
- `npm install -g npm-check-updates`
|
|
||||||
- `npm-check-updates -u`
|
|
||||||
- `npm install`
|
|
||||||
|
|
||||||
BrowserSync will automatically inject, refresh and sync all your browsers.
|
|
||||||
|
|
||||||
2. **Set your project**
|
|
||||||
- `build/browserSync.js` update proxy
|
|
||||||
- `assets/scripts/utils/environment.js` update `APP_NAME`
|
|
||||||
|
|
||||||
3. **Run grunt, BrowserSync and start coding**
|
|
||||||
- `grunt sync`
|
|
||||||
|
|
||||||
### Grunt
|
|
||||||
|
|
||||||
Each Grunt task has it's own file in the `grunt_tasks` folder.
|
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
Change the mentions of `boilerplate` for your project's name in
|
||||||
|
- `mconfig.json`
|
||||||
|
- `assets/scripts/utils/environment.js`
|
||||||
|
|
||||||
## CSS
|
## CSS
|
||||||
|
|
||||||
@@ -127,4 +119,4 @@ Legend
|
|||||||
`display()` -> (BaseTransition) `displayView()` -> display animations & `*readyToDestroy`
|
`display()` -> (BaseTransition) `displayView()` -> display animations & `*readyToDestroy`
|
||||||
-> init new modules
|
-> init new modules
|
||||||
|
|
||||||
`[readyToRemove]` -> reinit()
|
`[readyToRemove]` -> reinit()
|
||||||
|
|||||||
Reference in New Issue
Block a user