rayelliott
/
understrap
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

This commit is contained in:
Holger 2016-12-15 16:23:58 +01:00 committed by GitHub
parent 8ac3259888
commit d98681e985
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -11,7 +11,7 @@ At the moment, UnderStrap is in a very early stage. But if you want, feel free t
# UnderStrap WordPress Theme Framework # UnderStrap WordPress Theme Framework
Website: [http://understrap.com](http://understrap.com) Website: [https://understrap.com](https://understrap.com)
Child Theme Project: [https://github.com/holger1411/understrap-child](https://github.com/holger1411/understrap-child) Child Theme Project: [https://github.com/holger1411/understrap-child](https://github.com/holger1411/understrap-child)
@ -62,19 +62,33 @@ Some basics about the Sass and CSS files that come with UnderStrap:
## Installation ## Installation
- Download the understrap folder from GitHub or from understrap.com ### Classic install
- Download the understrap folder from GitHub or from [https://understrap.com](https://understrap.com)
- IMPORTANT: If you download it from GitHub make sure you rename the "understrap-master.zip" file just to "understrap.zip" or you might have problems using child themes !! - IMPORTANT: If you download it from GitHub make sure you rename the "understrap-master.zip" file just to "understrap.zip" or you might have problems using child themes !!
- Upload it into your WordPress installation subfolder here: `/wp-content/themes/` - Upload it into your WordPress installation subfolder here: `/wp-content/themes/`
- Login to your WordPress backend - Login to your WordPress backend
- Go to Appearance → Themes - Go to Appearance → Themes
- Activate the UnderStrap theme - Activate the UnderStrap theme
### npm install
- Open your terminal
- Change to the directory where you want to add UnderStrap
- Type `npm install understrap`
### WordPress.org install
- Open your WordPress backend
- Click on "Appearance -> Themes"
- Hit the "Add new" button
- Search for "UnderStrap"
- Hit the "install" button
- Activate the theme
## Developing With npm, Gulp and SASS and [Browser Sync][1] ## Developing With npm, Gulp and SASS and [Browser Sync][1]
### Installing Dependencies ### Installing Dependencies
- Make sure you have installed Node.js and Browser-Sync* (* optional, if you wanna use it) on your computer globally - Make sure you have installed Node.js and Browser-Sync* (* optional, if you wanna use it) on your computer globally
- Then open your terminal and browse to the location of your UnderStrap copy - Then open your terminal and browse to the location of your UnderStrap copy
- Run: `$ npm install` and then: `$ gulp copy-assets` - Run: `$ npm install`
### Running ### Running
To work and compile your Sass files on the fly start: To work and compile your Sass files on the fly start: