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

adjusting readme.txt for 0.4.8

This commit is contained in:
koenemann 2016-10-10 15:20:46 +02:00
parent 1d917cdb88
commit 2b375fd74a
1 changed files with 36 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
readme.txt
View File

@ -1,11 +1,13 @@
Start talking: [![Gitter](https://img.shields.io/gitter/room/holger1411/understrap.svg?maxAge=2592000?style=flat-square)](https://gitter.im/holger1411/understrap)
## About ## About
I’m a huge fan of Underscores, Bootstrap, and Sass. Why not combine these into a solid WordPress Theme Framework? 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. 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. 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.
At the moment, UnderStrap is in a very early stage. But if you want, 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!
# UnderStrap WordPress Theme Framework # UnderStrap WordPress Theme Framework
@ -19,17 +21,27 @@ UnderStrap is released under the terms of the GPL version 2 or (at your option)
http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
## Changelog ## Changelog
- ** 0.4.7 Aug. 15the 2016 ** - ** 0.4.8 Oct. 10th 2016 **
- Removing Bower and replace the dependency managment with npm
- Update to Bootstrap 4 Alpha 4
- Optimizing WooCommerce loop - Thx @typeplus
- Updating all dependencies
- Add WP Theme logo feature - Thx @jessijean
- ** 0.4.7 Aug. 15th 2016 **
- Fixing problem with tag page - Fixing problem with tag page
- Fixing Navbar "hopping" - Fixing Navbar "hopping"
- Global bugfixing and streamlining performance issues - Global bugfixing and streamlining performance issues
- ** 0.4.6 Aug. 1st 2016 ** - ** 0.4.6 Aug. 1st 2016 **
- Update to Bootstrap 4 Alpha 3 - Update to Bootstrap 4 Alpha 3
- Adding basic padding to aligned content images - Adding basic padding to aligned content images
- Adding author.php template with author infos - Adding author.php template with author infos
- Correct language file + german translation - Correct language file + german translation
- ** 0.4.5 Jun. 20th 2016 ** - ** 0.4.5 Jun. 20th 2016 **
- Adding right sanitizing function for customizer - Adding right sanitizing function for customizer
- Fixing some escaping problems - Fixing some escaping problems
@ -39,7 +51,8 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
- Remove unused code, files and dependencies - Remove unused code, files and dependencies
- Adding credits for WP Bootstrap Navwalker by Edward McIntyre - Adding credits for WP Bootstrap Navwalker by Edward McIntyre
- **0.4.4 Jun. 18th 2016 **
- ** 0.4.4 Jun. 18th 2016 **
- Adding the new empty.php page template. Comes just with header, footer and a content area without markup. Good for build up landingpages. An empty canvas for your Bootstrap markup. - Adding the new empty.php page template. Comes just with header, footer and a content area without markup. Good for build up landingpages. An empty canvas for your Bootstrap markup.
- Update bower.json dependencies to latest versions - Update bower.json dependencies to latest versions
- Update package.json dependencies to latest versions - Update package.json dependencies to latest versions
@ -49,7 +62,7 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
- Smaller bugfixes and code improvements - Smaller bugfixes and code improvements
- **0.4.0 Apr. 29th 2016 ** - ** 0.4.0 Apr. 29th 2016 **
- Switching from Bootstrap 3 to Bootstrap 4 - Switching from Bootstrap 3 to Bootstrap 4
- Adding BrowserSync to gulpfile (again thx to @dvlopes) - Adding BrowserSync to gulpfile (again thx to @dvlopes)
- Preparing the navbar markup so that the current version will work with Bootstrap 3 AND 4 - Preparing the navbar markup so that the current version will work with Bootstrap 3 AND 4
@ -61,12 +74,12 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
- Adding Brazilian Portuguese (pt-BR) translation (thx to @dvlopes). - Adding Brazilian Portuguese (pt-BR) translation (thx to @dvlopes).
- **0.3.8 Mar. 9th 2016 ** - ** 0.3.8 Mar. 9th 2016 **
- Adding footer widget area - Adding footer widget area
- Adjust Bootstrap markup for searchform and search widget - Adjust Bootstrap markup for searchform and search widget
- **0.3.7 Jan. 8th 2016** - ** 0.3.7 Jan. 8th 2016**
- Cleanup for submitting to WordPress.org theme repository: - Cleanup for submitting to WordPress.org theme repository:
- Fixing sticky post problem - Fixing sticky post problem
- Fixing skip-to-content link - Fixing skip-to-content link
@ -75,45 +88,45 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
- Fixing missing translation strings in comments template - Fixing missing translation strings in comments template
- **0.3.6 Jan. 4th 2016** - ** 0.3.6 Jan. 4th 2016**
- Cleanup - Cleanup
- Updating dependencies - Updating dependencies
- Upgrade to Bootstrap 3.3.6 and Font Awesome 4.5.0 - Upgrade to Bootstrap 3.3.6 and Font Awesome 4.5.0
- **0.3.4 SEP. 9th 2015** - ** 0.3.4 SEP. 9th 2015**
- Adding basic WooCommerce support - Adding basic WooCommerce support
- Cleanup for submitting to wordpress.org - Cleanup for submitting to wordpress.org
- Removing _s SASS ... no need for basic styling. Thats Bootstrap´s job. - Removing _s SASS ... no need for basic styling. Thats Bootstrap´s job.
- **0.3.1 AUG. 12th 2015** - ** 0.3.1 AUG. 12th 2015**
- Adding bower dependency manager and replacing GRUNT taskrunner with GULP - Adding bower dependency manager and replacing GRUNT taskrunner with GULP
- **0.3.0 Mar. 23th 2015** - ** 0.3.0 Mar. 23th 2015**
- Streamlining some code, adding extra "sticky" area (sticky posts above the main content area inside an extra loop). Fixing some child theme issues (now its really child theme ready...really...trust me...) - Streamlining some code, adding extra "sticky" area (sticky posts above the main content area inside an extra loop). Fixing some child theme issues (now its really child theme ready...really...trust me...)
- **0.2.9 Mar. 10th 2015** - ** 0.2.9 Mar. 10th 2015**
- Adding a new theme customizer option. It lets you add a code snippet right before the closing </body> tag. - Adding a new theme customizer option. It lets you add a code snippet right before the closing </body> tag.
For example for Google Analytics, Google Tag Mananger, Pingdom etc. Just copy and past your code to the input field and save the setting. For example for Google Analytics, Google Tag Mananger, Pingdom etc. Just copy and past your code to the input field and save the setting.
So you don´t have to edit the theme source file´s directly and your theme stay´s updateable So you don´t have to edit the theme source file´s directly and your theme stay´s updateable
- **0.2.8 Feb. 6th 2015** - ** 0.2.8 Feb. 6th 2015**
- Adding Grunt and Grunt SASS task - Adding Grunt and Grunt SASS task
- **0.2.7 Jan. 26th 2015** - ** 0.2.7 Jan. 26th 2015**
- Adding some basic theme option for the build-in slider script - Adding some basic theme option for the build-in slider script
- **0.2.6 Dec. 28th 2014** - ** 0.2.6 Dec. 28th 2014**
- CLean up - CLean up
- **0.2 Dec. 22th 2014** - ** 0.2 Dec. 22th 2014**
- Adding Jasny Off-Canvas nav and Owl.Carousel Slider script - Adding Jasny Off-Canvas nav and Owl.Carousel Slider script
- Enqueue scipts and styled dynamically - Enqueue scipts and styled dynamically
- **0.1 Dec. 10th 2014 - First commit** - ** 0.1 Dec. 10th 2014 - First commit**
## Basic Features ## Basic Features
@ -121,8 +134,8 @@ http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
- Combines Underscore’s PHP/JS files and Bootstrap’s HTML/CSS/JS. - 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. - 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 and minified CSS file for all the basic stuff.
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/) integration (v4.6.0) - [Font Awesome](http://fortawesome.github.io/Font-Awesome/) integration (v4.6.3)
- Comes with extra slider script by [Owl Carousel](http://www.owlcarousel.owlgraphic.com/) (v2.0.0-beta.2.4) - Comes with extra slider script by [Owl Carousel](http://www.owlcarousel.owlgraphic.com/) (v2.1.4)
- Simple RTL file. - Simple RTL file.
- Jetpack ready. - Jetpack ready.
- WooCommerce support. - WooCommerce support.
@ -138,7 +151,7 @@ Why not add a well known and supported layout framework to have a solid, clean a
Some basics about the Sass and CSS files that come with UnderStrap: 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 just 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` file provides all styles. It is composed of five different SCSS sets and one variable file at `/sass/theme.scss`: - The `/css/theme.css` and it´s 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 - 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!
@ -160,12 +173,12 @@ Some basics about the Sass and CSS files that come with UnderStrap:
- 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, 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 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` then: `$ bower install` and finally: `$ gulp copy-assets` - Run: `$ npm install` and then: `$ 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:
@ -199,3 +212,4 @@ Licenses & Credits
- Owl Carousel 2: http://www.owlcarousel.owlgraphic.com/ | https://github.com/smashingboxes/OwlCarousel2/blob/develop/LICENSE (Code licensed under MIT) - Owl Carousel 2: http://www.owlcarousel.owlgraphic.com/ | https://github.com/smashingboxes/OwlCarousel2/blob/develop/LICENSE (Code licensed under MIT)
and of course and of course
- jQuery: https://jquery.org | (Code licensed under MIT) - jQuery: https://jquery.org | (Code licensed under MIT)
- WP Bootstrap Navwalker by Edward McIntyre: https://github.com/twittem/wp-bootstrap-navwalker | GNU GPL