Skip to content
This repository has been archived by the owner on Sep 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #587 from olefredrik/documentation
Browse files Browse the repository at this point in the history
Documentation
  • Loading branch information
olefredrik committed Dec 7, 2015
2 parents df73ca0 + 41a4f8c commit cc0937d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 13 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ $ npm install
$ npm run watch
```

If you want to take advantage of browser-sync (automatic browser refresh when a file is saved), simply enter the URL of your local WP-server in Gruntfile.js line 200, save and run
If you want to take advantage of browser-sync (automatic browser refresh when a file is saved), simply open your Gulpfile.js and put your local dev-server address (e.g localhost) in this field ```var URL = '';``` , save the Gulpfile and run
```bash
$ npm run browsersync
$ npm run watch
```

### 3. For building all the assets, run:
Expand All @@ -44,16 +44,11 @@ $ npm run browsersync
$ npm run build
```

### 4. Compress all files required for deployment:
It is not recommended that you deploy the entire theme folder to your webserver. There is no danger associated with doing this, but it is a waste of disk space and bandwidth. The node_modules and components for instance is only required during theme development.

By executing the command below, you will compress only the files that are required for deployment. The file will be available as a .zip inside the folder named '/packaged'.

Build all assets minified and without sourcemaps:
```bash
$ npm run package
$ npm run production
```


### Styles

* `style.css`: Do not worry about this file. (For some reason) it's required by WordPress. All styling are handled in the Sass files described below
Expand All @@ -64,13 +59,13 @@ $ npm run package
* `assets/scss/modules/*.scss`: Topbar, footer etc.
* `assets/scss/templates/*.scss`: Page template spesific styling

Please note that you **must** run `npm run build` or `npm run watch` in your terminal for the styles to be copied and concatinated. See the [Gruntfile.js](https://github.com/olefredrik/FoundationPress/blob/master/Gruntfile.js) for details
Please note that you **must** run `npm run build` or `npm run watch` in your terminal for the styles to be copied and concatinated. See the [Gulpfile.js](https://github.com/olefredrik/FoundationPress/blob/master/gulpfile.js) for details

### Scripts

* `assets/javascript/custom`: This is the folder where you put all your custom scripts. Every .js file you put in this directory will be minified and concatinated one single .js file. (This is good for site speed and performance)

Please note that you must run `npm run build` or `npm run watch` in your terminal for the scripts to be copied and concatinated. See [Gruntfile.js](https://github.com/olefredrik/FoundationPress/blob/master/Gruntfile.js) for details
Please note that you must run `npm run build` or `npm run watch` in your terminal for the scripts to be copied and concatinated. See [Gulpfile.js](https://github.com/olefredrik/FoundationPress/blob/master/gulpfile.js) for details

### The main styles and scripts generated by the build

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "foundationpress",
"title": "FoundationPress",
"version": "2.0.0",
"version": "2.1.0",
"description": "FoundationPress is a WordPress starter theme based on Foundation 6 by Zurb",
"keywords": [
"FoundationPress",
Expand Down
2 changes: 1 addition & 1 deletion style.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Theme Name: FoundationPress
Theme URI: http://foundationpress.olefredrik.com
Github Theme URI: https://github.com/olefredrik/FoundationPress
Description: FoundationPress is a WordPress starter theme based on Foundation 6 by Zurb
Version: 2.0.0
Version: 2.1.0
Author: Ole Fredrik Lie
Author URI: http://olefredrik.com/
Expand Down

0 comments on commit cc0937d

Please sign in to comment.