-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.txt
143 lines (86 loc) · 8.42 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# Wireframe Theme
***Clone it. Extend it. Sell it.***
Wireframe Theme is an OOP WordPress parent theme boilerplate. Wireframe Theme enables WordPress Developers to rapidly wire [GPL](https://www.gnu.org/licenses/gpl-2.0.html) and [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards) compliant themes for professional client projects or for selling premium themes in any marketplace.
Wireframe Theme is part of the [Wireframe Suite](https://github.com/mixatheme/Wireframe) for WordPress by  [MixaTheme](https://github.com/mixatheme/wireframe-theme#about-mixatheme).
---
### Table of Contents
[Status](https://github.com/mixatheme/wireframe-theme#status) | [Requirements](https://github.com/mixatheme/wireframe-theme#requirements) | [Points of Interest](https://github.com/mixatheme/wireframe-theme#points-of-interest) | [Caveats](https://github.com/mixatheme/wireframe-theme#caveats) | [Support](https://github.com/mixatheme/wireframe-theme#support) | [Contributing](https://github.com/mixatheme/wireframe-theme#contributing)
---
### Status
[](https://travis-ci.org/mixatheme/wireframe-theme)
* **Created by:** [Tada Burke](https://twitter.com/tadaburke)
* **Maintained by:**  [MixaTheme](https://github.com/mixatheme/wireframe-theme#about-mixatheme)
* **Phase:** Beta-1
* **Version:** 0.1.0
* **Tested:** WordPress 4.9, PHP 7.1, all modern browsers.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
### Requirements
Wireframe Theme encourages Developers to use the requirements listed below, but this is ultimately up to each Developer or Team. Due to the rapid advancement of tech these days, Wireframe Theme will generally support software no more than 2 major point releases behind.
1. LAMP, LEMP or any server running PHP, MySQL or MariaDB. Nginx is highly recommended.
2. **PHP version 5.6** or greater. PHP 7.0+ is highly recommended.
3. MySQL version 5.5 or greater OR MariaDB version 10.0 or greater.
4. WordPress version 4.8.1 or greater.
5. Intermediate knowledge of the [Wordpress Codex](https://codex.wordpress.org), [Theme Development](https://developer.wordpress.org/themes/) and [Plugin Development](https://developer.wordpress.org/plugins/).
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
### Points Of Interest
Wireframe Theme takes a unique approach to WordPress theme development...
* [Object Oriented Programming](http://stackoverflow.com/questions/1530868/simple-explanation-php-oop-vs-procedural) (OOP)
* [Inversion of Control](http://stackoverflow.com/questions/18562752/understanding-ioc-containers-and-dependency-injection) (IoC)
* [Dependency Injection](http://stackoverflow.com/questions/2255771/how-can-i-use-dependency-injection-in-simple-php-functions-and-should-i-bothe) (DI)
* [DRY](http://stackoverflow.com/questions/6453235/what-does-damp-not-dry-mean-when-talking-about-unit-tests) principles.
* [PHP Namespaces](http://stackoverflow.com/questions/3384204/what-are-namespaces).
* [PSR-4](http://www.php-fig.org/psr/psr-4/) PHP Standards Recommendations.
* [Bootstrapping](http://stackoverflow.com/questions/1254542/what-is-bootstrapping) functions.php.
* [Composer](https://getcomposer.org) dependency management for autloading.
* [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) compliance.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
### Caveats
Wireframe Theme may or may not be a good fit for your next project. Please take a look at the Requirements, Wiki, Issues and source code to get a feel if Wireframe Theme is what you're looking for.
Various components & modules may use different licenses due to certain library dependencies. For example: [Wireframe Child](https://github.com/mixatheme/wireframe-child/) theme must be GPL-3.0+ because it uses Bootstrap, but [Wireframe Theme](https://github.com/mixatheme/wireframe-theme/) is still licensed under GPL-2.0 or greater.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
### Support
Have a question? Head on over to the Wiki first. Then, head on over to the Issues and start a new thread.
* :books: [Wiki](https://github.com/mixatheme/wireframe-theme/wiki) - View some FAQs before you open an Issue.
* :octocat: [Issues](https://github.com/mixatheme/wireframe-theme/issues) - Start a new relevant discussion or open an Issue.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
### Contributing
We :heart: and thank all contributions.
* :bulb: [Issues](https://github.com/mixatheme/wireframe-theme/issues) - Volunteer and help other Developers.
* :earth_asia: [Translation](https://github.com/mixatheme/wireframe-theme/issues) - Help translate into your language.
* :octocat: [Pull Requests](https://github.com/mixatheme/wireframe-theme/pulls) - Help make Wireframe Theme better.
* :beetle: [Report A Bug](https://github.com/mixatheme/wireframe-theme/issues) - Help us squash unruly bugs.
* :gift: [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KVFZAV7646BEL) - Or purchase any of our [commercial products](https://github.com/mixatheme/wireframe-theme#about-mixatheme). Thank you, every bit helps!
* :x: Do not report vulnerabilities publicly. Please use the contact form on our website. Thanks.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
### Thank You
* [Underscores](https://github.com/Automattic/_s) - Some code inspired by _s theme from Automattic.
* [TwentySixteen](https://github.com/WordPress/twentysixteen) - Some code inspired by TwentySixteen theme by Automattic.
* [TwentySeventeen](https://github.com/WordPress/twentyseventeen) - Some code inspired by TwentySeventeen theme by Automattic.
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
### Copyright
Wireframe Theme is Copyright © 2012-2017 [Tada Burke](https://twitter.com/tadaburke), [MixaTheme](https://mixatheme.com). All rights reserved.<br>
### License
**Please verify GPL-compatible licenses when you package your Wireframe products.**
This software is licensed under GPL-2.0+ ( see [LICENSE](https://github.com/mixatheme/wireframe-theme/blob/master/LICENSE) ).
This software is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this software. If not, see <http://www.gnu.org/licenses/>.
---
### About MixaTheme
[MixaTheme](https://mixatheme.com) is the software development studio founded by [Tada Burke](https://twitter.com/tadaburke).
*More free and commercial open-source software by MixaTheme...*
###  [Wireframe](https://github.com/mixatheme/Wireframe)
Wireframe is a suite of free object-oriented components for creating modular WordPress themes & plugins. You extend Wireframe to deliver professional client projects or for selling premium marketplace products to the world.
###  [Mainframe](https://mixatheme.com)
Frustrated buying dozens of throwaway themes? Love Bootstrap, Foundation, HTML5 Boilerplate, Skeleton but wanna test drive Neat, Susy, Material UI, Unsemantic, Ink, Kube, Bulma, etc? Mainframe is our flagship smart theme for WordPress! Use any grid. Use any front-end framework. Use your creativity in one single theme.
**Thanks for using MixaTheme products! Follow us?** [Twitter](https://twitter.com/mixatheme) | [Facebook](https://facebook.com/MixaTheme) | [Updates](https://mixatheme.com)
[Top](https://github.com/mixatheme/wireframe-theme#wireframe-theme)
---
Proudly [ethical](https://github.com/mixatheme/wireframe-ethics) :heart: for [WordPress](https://wordpress.org)