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

- Minor grammar and spelling corrections. 

- Updated copyright dates.
- Added introduction explanation of installation methods, was a little confusing at first glance whether all three of these needed to be performed or only one, thought this would help clarify.
- Added a similar section to Page Templates to help clarify purpose of section.
This commit is contained in:
Dave Mackey 2018-06-05 23:46:13 -04:00
parent a507ce7ea5
commit b3345daa6b
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,10 +10,10 @@ Child Theme Project: [https://github.com/understrap/understrap-child](https://gi
## About ## About
I’m a huge fan of Underscores, Bootstrap, and Sass. Why not combine these into a solid WordPress Theme Framework? That’s what UnderStrap is. You can use it as starter theme and build your own theme on top of it. Or you can use it as a parent theme and create your own child theme for UnderStrap. I’m a huge fan of Underscores, Bootstrap, and Sass. Why not combine these into a solid WordPress Theme Framework? That’s what UnderStrap is. You can use it as a starter theme and build your own theme on top of it. Or you can use it as a parent theme and create your own child theme for UnderStrap.
## License ## License
UnderStrap WordPress Theme, Copyright 2013-2017 Holger Koenemann UnderStrap WordPress Theme, Copyright 2013-2018 Holger Koenemann
UnderStrap is distributed under the terms of the GNU GPL version 2 UnderStrap is distributed under the terms of the GNU GPL version 2
http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
@ -53,18 +53,19 @@ Some basics about the Sass and CSS files that come with UnderStrap:
@import "theme/theme"; // 5. Add your styles into this file @import "theme/theme"; // 5. Add your styles into this file
``` ```
- Don’t edit the files no. 2-4 files/filesets or you won’t be able to update it without overwriting your own work! - Don’t edit the number 2-4 files/filesets listed above or you won’t be able to update Understrap without overwriting your own work!
- Your design goes into: `/sass/theme`. - Your design goes into: `/sass/theme`.
- Add your styles to the `/sass/theme/_theme.scss` file - Add your styles to the `/sass/theme/_theme.scss` file
- And your variables to the `/sass/theme/_theme_variables.scss` - And your variables to the `/sass/theme/_theme_variables.scss`
- Or add other .scss files into it and `@import` it into `/sass/theme/_theme.scss`. - Or add other .scss files into it and `@import` it into `/sass/theme/_theme.scss`.
## Installation ## Installation
There are several ways to install UnderStrap. We'll look at three of them: (1) classic install by uploading UnderStrap to a WordPress install, (2) using npm, and (3) using the theme directory in WordPress.
### Classic install ### Classic install
- Download the understrap folder from GitHub or from [https://understrap.com](https://understrap.com) - 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: `/wp-content/themes/` - Upload it into your WordPress installation theme subfolder: `/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
@ -108,7 +109,7 @@ Or, to run with Browser-Sync:
``` ```
- then run: `$ gulp watch-bs` - then run: `$ gulp watch-bs`
## How to Use the Build-In Widget Slider ## How to Use the Built-In Widget Slider
The front-page slider is widget driven. Simply add more than one widget to widget position “Hero”. The front-page slider is widget driven. Simply add more than one widget to widget position “Hero”.
- Click on Appearance → Widgets. - Click on Appearance → Widgets.
@ -120,6 +121,7 @@ Add a new file to the themes root folder called rtl.css. Add all alignments to t
https://codex.wordpress.org/Right_to_Left_Language_Support https://codex.wordpress.org/Right_to_Left_Language_Support
## Page Templates ## Page Templates
UnderStrap includes several different page template files: (1) blank template, (2) empty template, and (3) full width template.
### Blank Template ### Blank Template