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

Better English and typography in README.md

This commit is contained in:
Kyle Morgan 2016-04-26 15:51:49 -06:00
parent b14895924f
commit 6a78d0ac76
1 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -76,34 +76,34 @@ Changelog
About About
= =
Basically I like the _s WordPress Starter Theme from Automattic and the grid Framework Bootstrap. Additionally I´am a huge SASS fan. Why don´t combine all these three things into a solid WordPress Theme Framework? I’m a huge fan of Underscores, Bootstrap, and Sass. Why not combine these three into a solid WordPress Theme Framework?
That´s what UnderStrap is (or will be...) That’s what UnderStrap is (or will be...)
At the moment UnderStrap is in a very early stage. But if you wan´t feel free to use it for your own WordPress theme! At the moment, UnderStrap is in a very early stage. But if you wan’t, feel free to use it for your own WordPress theme!
Basic Features Basic Features
= =
- Combines the _s WordPress Starter Theme PHP/JS files and Bootstrap´s HTML/CSS/JS - Combines Underscore’s PHP/JS files and Bootstrap’s HTML/CSS/JS.
- Comes with Bootstrap (3.3.6) SASS source files and additional scss files. Nicely sorted and ready to add your own variables/customize the Bootstrap variables. - Comes with Bootstrap (v3.3.6) Sass source files and additional .scss files. Nicely sorted and ready to add your own variables and customize the Bootstrap variables.
- Uses a single and minified CSS file for all the basic stuff - Uses a single and minified CSS file for all the basic stuff.
- Font Awesome Icon Font integrated (V 4.5.0): [http://fortawesome.github.io/Font-Awesome/](http://fortawesome.github.io/Font-Awesome/) - Font Awesome integration (v4.5.0): [http://fortawesome.github.io/Font-Awesome/](http://fortawesome.github.io/Font-Awesome/)
- Comes with extra slider script - By owl.carousel (V 2.0.0-beta.2.4): [http://www.owlcarousel.owlgraphic.com/](http://www.owlcarousel.owlgraphic.com/) - Comes with extra slider script by Owl Carousel (v2.0.0-beta.2.4): [http://www.owlcarousel.owlgraphic.com/](http://www.owlcarousel.owlgraphic.com/)
- Simple RTL file - Simple RTL file
- Jetpack ready - Jetpack ready
- WooCommerce support - WooCommerce support
- Child Theme ready (A basic starter Child Theme will be released in the future as a separate Repository) - Child Theme ready [https://github.com/holger1411/understrap-child](https://github.com/holger1411/understrap-child)
- Translation ready - Translation ready
Starter Theme + HTML Framework = WordPress Theme Framework Starter theme + HTML framework = WordPress theme framework
= =
The _s theme is a good starting point to develope a WordPress theme. But it is "just" a raw starter theme. Means it outputs all the WordPress stuff correctly but without any layout or design. The _s theme is a good starting point to develop a WordPress theme. But it is “just” a raw starter theme. That means it outputs all the WordPress stuff correctly but without any layout or design.
Why don´t add a well known and supported layout framework to have a solid, clean and responsive foundation? Thats where Bootstrap comes in. Why not add a well known and supported layout framework to have a solid, clean and responsive foundation? That’s where Bootstrap comes in.
Confused by all the CSS and SCSS files? Confused by all the CSS and SCSS files?
= =
Some basics about the SCSS and CSS files comes with UnderStrap: Some basics about the SCSS and CSS files that come with UnderStrap:
- The theme itself uses the style.css in the root directory just to identify the theme inside of WordPress. The file is not loaded by the theme and did not include any styles - The theme itself uses the `/style.css`file just to identify the theme inside of WordPress. The file is not loaded by the theme and does not include any styles.
- The theme.css file in /css/ subdirectory provides all styles. It is composed by five different SCSS sets and one variables file from /sass/theme.scss: - The `/css/theme.css` file provides all styles. It is composed of five different SCSS sets and one variable file at `/sass/theme.scss`:
- 1 "theme/theme_variables"; // <--------- Add your variables into this file. Also add variables to overwrite Bootstrap or UnderStrap variables here - 1 "theme/theme_variables"; // <--------- Add your variables into this file. Also add variables to overwrite Bootstrap or UnderStrap variables here
- 2 "../src/bootstrap-sass/assets/stylesheets/bootstrap"; // <--------- All the Bootstrap stuff - Don´t edit this! - 2 "../src/bootstrap-sass/assets/stylesheets/bootstrap"; // <--------- All the Bootstrap stuff - Don´t edit this!
@ -113,32 +113,32 @@ Some basics about the SCSS and CSS files comes with UnderStrap:
// Any additional imported files // // Any additional imported files //
- 5 "theme/theme"; // <--------- Add your styles into this file - 5 "theme/theme"; // <--------- Add your styles into this file
- Don´t edit the files no. 2-4 files/filesets or you aren´t able to update it without overwriting your own work! - Don’t edit the files no. 2-4 files/filesets or you won’t be able to update it without overwriting your own work!
- Your design goes into: /sass/theme directory. Add your styles to the theme.scss file and your variables to the _theme_variables.scss. Or add other scss files into it and @import it into theme.scss - Your design goes into: `/sass/theme`. Add your styles to the `/sass/theme/_theme.scss` file 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`.
Installation Installation
= =
- Download the understrap folder - Download the understrap folder
- 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
Developing with NPM, Bower, Gulp and SASS and [Browser Sync][1] Developing with NPM, Bower, Gulp and SASS and [Browser Sync][1]
= =
### Installing dependencies ### Installing dependencies
- Make sure you have installed Node.js, Bower and Browser-Sync on your computer globally - Make sure you have installed Node.js, Bower, and Browser-Sync 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` then: `$ bower install` and finally: `$ gulp copy-assets` - Run: `$ npm install` then: `$ bower install` and finally: `$ gulp copy-assets`
### Running ### Running
To work and compile your SASS files on the fly start: To work and compile your Sass files on the fly start:
- `$ gulp watch` - `$ gulp watch`
Or, to run with Browser-Sync: Or, to run with Browser-Sync:
- First change the browser-sync options to reflect your environment in the file `gulpfile.js` in the beginning of the file: - First change the browser-sync options to reflect your environment in the file `/gulpfile.js` in the beginning of the file:
```javascript ```javascript
var browserSyncOptions = { var browserSyncOptions = {
proxy: "localhost/theme_test/", // <----- CHANGE HERE proxy: "localhost/theme_test/", // <----- CHANGE HERE
@ -147,11 +147,11 @@ var browserSyncOptions = {
``` ```
- then run: `$ gulp watch-bs` - then run: `$ gulp watch-bs`
How to use the build-in Widget Slider? How to use the build-in widget slider
= =
The frontpage 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.
- Add two or more widgets of any kind to widget area "Hero" - Add two, or more, widgets of any kind to widget area “Hero”.
- Thats it - That‘s it.
[1] Visit [http://browsersync.io](http://browsersync.io) for more information on Browser Sync [1] Visit [http://browsersync.io](http://browsersync.io) for more information on Browser Sync