- Updated URL to understrap-child in README.
- Other minor grammar/spelling/formatting changes to README. - Similar with ISSUE_TEMPLATE.md
This commit is contained in:
Dave Mackey
parent
73c49ace16
commit
fb398db5d0
|
|
@ -9,11 +9,11 @@ Please delete anything that does not apply for you!
|
|||
|
||||
## Please tell us about your environment:
|
||||
|
||||
- WordPress Version: 4.9.x
|
||||
- OS Version: [Windows 7 | Windows 8 | Windows 10 | Linux [Distribution / Version] | MacOsX [Version | Android[Version] | iOS[Version]
|
||||
- Browser: [ all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari ]
|
||||
- Language: [ all | PHP | SQL | HTML | S/CSS | Javascript | jQuery | ES6 | JSON | XML]
|
||||
- Node.js & NPM Versions: Node.js [V X.XX] | NPM [V X.XX]
|
||||
- **WordPress Version:** 4.9.x
|
||||
- **OS Version:** [Windows 7 | Windows 8 | Windows 10] | Linux [Distribution / Version] | MacOS [Version] | Android [Version] | iOS [Version]
|
||||
- **Browser:** [ all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari ]
|
||||
- **Language:** [ all | PHP | SQL | HTML | S/CSS | Javascript | jQuery | ES6 | JSON | XML]
|
||||
- **Node.js & NPM Versions:** Node.js [V X.XX] | NPM [V X.XX]
|
||||
|
||||
|
||||
---
|
||||
|
|
|
|||
39
README.md
39
README.md
|
|
@ -6,13 +6,11 @@ Travis build: [
|
||||
|
||||
Child Theme Project: [https://github.com/holger1411/understrap-child](https://github.com/holger1411/understrap-child)
|
||||
Child Theme Project: [https://github.com/understrap/understrap-child](https://github.com/understrap/understrap-child)
|
||||
|
||||
## 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 use it as 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 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
|
||||
UnderStrap WordPress Theme, Copyright 2013-2017 Holger Koenemann
|
||||
|
|
@ -28,7 +26,7 @@ See [changelog](CHANGELOG.md)
|
|||
|
||||
- Combines Underscore’s PHP/JS files and Bootstrap’s HTML/CSS/JS.
|
||||
- Comes with Bootstrap (v4) 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 minified CSS file for all the basic stuff.
|
||||
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/) integration (v4.7.0)
|
||||
- Jetpack ready.
|
||||
- WooCommerce support.
|
||||
|
|
@ -44,26 +42,29 @@ Why not add a well known and supported layout framework to have a solid, clean a
|
|||
## Confused by All the CSS and Sass Files?
|
||||
|
||||
Some basics about the Sass and CSS files that come with UnderStrap:
|
||||
- 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 itself uses the `/style.css`file only to identify the theme inside of WordPress. The file is not loaded by the theme and does not include any styles.
|
||||
- The `/css/theme.css` and its minified little brother `/css/theme.min.css` file(s) 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
|
||||
- 2 "../src/bootstrap-sass/assets/stylesheets/bootstrap"; // <--------- All the Bootstrap stuff - Don´t edit this!
|
||||
- 3 "understrap/understrap"; // <--------- Some basic WordPress stylings and needed styles to combine Boostrap and Underscores
|
||||
- 4 "../src/fontawesome/scss/font-awesome"; // <--------- Font Awesome Icon styles
|
||||
|
||||
```@import "theme/theme_variables"; // 1. Add your variables into this file. Also add variables to overwrite Bootstrap or UnderStrap variables here
|
||||
@import "../src/bootstrap-sass/assets/stylesheets/bootstrap"; // 2. All the Bootstrap stuff - Don´t edit this!
|
||||
@import "understrap/understrap"; // 3. Some basic WordPress stylings and needed styles to combine Boostrap and Underscores
|
||||
@import "../src/fontawesome/scss/font-awesome"; // 4. Font Awesome Icon styles
|
||||
// Any additional imported files //
|
||||
- 5 "theme/theme"; // <--------- 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!
|
||||
- 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`.
|
||||
- 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
|
||||
|
||||
### 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 !!
|
||||
- Upload it into your WordPress installation subfolder here: `/wp-content/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/`
|
||||
- Login to your WordPress backend
|
||||
- Go to Appearance → Themes
|
||||
- Activate the UnderStrap theme
|
||||
|
|
@ -84,12 +85,12 @@ Some basics about the Sass and CSS files that come with UnderStrap:
|
|||
## Developing With npm, Gulp and SASS and [Browser Sync][1]
|
||||
|
||||
### 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) on your computer globally
|
||||
- Then open your terminal and browse to the location of your UnderStrap copy
|
||||
- Run: `$ npm install`
|
||||
|
||||
### Running
|
||||
To work and compile your Sass files on the fly start:
|
||||
To work with and compile your Sass files on the fly start:
|
||||
|
||||
- `$ gulp watch`
|
||||
|
||||
|
|
@ -115,7 +116,7 @@ The front-page slider is widget driven. Simply add more than one widget to widge
|
|||
- That’s it.
|
||||
|
||||
## RTL styles?
|
||||
Just add a new file to the themes root folder called rtl.css. Add all alignments to this file according to this description:
|
||||
Add a new file to the themes root folder called rtl.css. Add all alignments to this file according to this description:
|
||||
https://codex.wordpress.org/Right_to_Left_Language_Support
|
||||
|
||||
## Page Templates
|
||||
|
|
@ -132,6 +133,8 @@ The `empty.php` template displays a header and a footer only. A good starting po
|
|||
|
||||
The `fullwidthpage.php` template has full width layout without a sidebar.
|
||||
|
||||
## Footnotes
|
||||
|
||||
[1] Visit [http://browsersync.io](http://browsersync.io) for more information on Browser Sync
|
||||
|
||||
Licenses & Credits
|
||||
|
|
|
|||
Reference in New Issue