Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
104 lines (101 sloc) 5.67 KB
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<h1>&quot;CustoMaterial&quot; Material Design Wordpress Theme</h1>
<h2>About</h2>
<p>&quot;<em>CustoMaterial</em>&quot; is a fully responsive, highly performant and configurable Bootstrap-based Wordpress Theme following <a href="https://www.google.com/design/spec/material-design/introduction.html">Googles "Material Design" Guidelines</a>.</p>
<h2>License</h2>
<p>&quot;<em>CustoMaterial</em>&quot; is licensed under the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html" target="_blank">GNU General Public License, version 2</a></p>
<h2>Features</h2>
<ul>
<li>Full Bootstrap integration with all of Bootstraps Components modified to suit the Material Design principles.</li>
<li>Highly performant. &quot;CustoMaterial&quot; ranks with around 95% on GTMetrix out-of-the-box.</li>
<li>Nine fully configurable Widget-Areas:
<ul>
<li>Hero Slider</li>
<li>Static Hero</li>
<li>Above OffCanvas Navigation</li>
<li>Below OffCanvas Navigation</li>
<li>Sidebar</li>
<li>Four Footer Widget Areads</li>
</ul>
</li>
<li>Fully customizable. From background image, topbar and countless others to every color setting with more than 120 Configuration options already included.</li>
<li>Custom Post-Type "Portfolio" with custom metaboxes and embedded OWL2-Slider</li>
<li>Semantically correct HTML5 and crossbrowser-compatibel CSS3.</li>
<li>SEO-optimized code.</li>
<li>Fully accessible. Passes almost every &quot;A&quot; rule of the WCAG 2.0 guidelines. (Yet to be optimized though..)</li>
<li>WooCommerce-ready.</li>
<li>Translation ready. German translation will follow soon.</li>
<li>RTL-ready.</li>
<li>Jetpack-ready.</li>
</ul>
<h2>ToDo - Soon come..</h2>
<ul>
<li>German translation to be added.</li>
<li>Final WCAG 2.0 optimization to fulfill AA-Level.</li>
<li><a href="https://yoast.com/wordpress/plugins/seo/">Yoast-Seo</a> support. Also supports Yoast-breadcrumbs.</li>
<li>Custom Post Templates for Portfolio etc.</li>
<li>Custom Metaboxes for certain Post-Types.</li>
<li>Currently the GULP process is suboptimal. Needs <em>urgent</em> improvement!</li>
</ul>
<h2>Credits</h2>
<p>Full Credit goes to <a href="https://github.com/holger1411">Holger Könemann</a> who built a solid foundation to &quot;CustoMaterial&quot; with his <a href="https://github.com/holger1411/understrap">Wordpress Starter Theme &quot;Understrap&quot;</a>. Understrap integrates Automattics _s with Bootstrap, SCSS and has an optimized Workflow integrating <a href="http://bower.io/">Bower</a> and <a href="http://gulpjs.com/">GULP</a>.</p>
<p>Credits go to the following projects and persons:</p>
<ul>
<li><strong>Understrap:</strong> https://github.com/holger1411/understrap ()</li>
<li><strong>Kirki Customizer Toolkit:</strong> http://kirki.org (Code licensed under GPLv2 License)</li>
<li><strong>CMB2 Custom Metaboxes Framework:</strong> https://github.com/WebDevStudios/CMB2 (Code licensed under GPLv2 License)</li>
<li><strong>Bootstrap Material Design:</strong> https://github.com/FezVrasta/bootstrap-material-design (Code licensed under MIT License)</li>
<li> <strong>Owl Carousel 2:</strong> http://www.owlcarousel.owlgraphic.com (Code licensed under MIT License)</li>
<li> <strong>Font Awesome:</strong> http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)</li>
</ul>
<h2>Installation</h2>
<ul>
<li> Download the <a href="https://github.com/Thomas-A-Reinert/CustoMaterial/archive/master.zip">&quot;<em>CustoMaterial</em>&quot; Package</a></li>
<li>Upload it into your WordPress installation subfolder here: /wp-content/themes/</li>
<li>Login to your WordPress backend </li>
<li> Go to Appearance -&gt; Themes</li>
<li>Activate the &quot;<em>CustoMaterial</em>&quot; theme</li>
<li>Go to the Customizer to customize &quot;<em>CustoMaterial</em>&quot; to your liking</li>
</ul>
<h3>How to use the built-in Widget Slider and the Static Hero?</h3>
<p> The Frontpage Slider is Widget driven. Simply add more than one Widget to widget position &quot;<em>Hero Slider</em>&quot;.</p>
<ul>
<li>Click on Appearance -&gt; Widgets</li>
<li>Add two or more widgets of any kind to widget area &quot;Hero Slider&quot;</li>
<li>Thats all, folks..</li>
</ul>
<p>If you just want a static Hero header or want a second below the Hero Slider, you should add a Widget to the &quot;<em>Static Hero</em>&quot; Widget.</p>
<h2>Changelog</h2>
<h3>Version 0.2</h3>
<p>March 1st, 2016</p>
<ul>
<li>*Update* WCAG 2.0 compliance</li>
<li>*Update* Change Gulp-file for more flexibility. (Needs _urgent_ improvement now!)</li>
<li>*Update* Update Kirki Customizer Framework and CMB2 Custom Metaboxes to latest version.</li>
<li>*Update* Some layout improvements.</li>
<li>*Update* Remove/improve some customizer illogicality.</li>
<li>*Update* Default color changes in customizer.</li>
<li>*Update* Update base language and translation strings.</li>
<li>*Update* Integrate Yoast SEO Breadcrumbs into template if present.</li>
<li>*Update* Improve 404 page output to better support grid and take advantage of it.</li>
<li>*Update* Clean up and addons to SASS/CSS styles.</li>
<li>*Fix* Fix layout of the search-button in the offcanvas navigation.</li>
<li>*Fix* Offcanvas navigation top-offset. Support admin-bar offset.</li>
<li>*NEW* Integrate sidebar-switch and fullwidth/boxed layout. Switching logic for columns implemented</li>
<li>*NEW* Custom post-type "Portfolio" with embedded Owl-Slider and custom Metaboxes</li>
</ul>
<h3>Version 0.1 </h3>
<p>February 24th, 2016</p>
<ul>
<li>Initial commit.</li>
<li>Some improvements to match WCAG 2.0 guidelines.</li>
</ul>
<p><br>
</p>
</body>
</html>