You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 14, 2024. It is now read-only.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copy file name to clipboardexpand all lines: README.md
+20-9
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Tonik
2
2
3
-
### The Tonik Starter Theme aims to modernize, organise and simplify some aspects of WordPress theme development. Take a look at what is waiting for you:
Install back-end dependeces and generate autoloading file.
44
+
Install back-end dependencies and generate an autoloading file.
43
45
44
46
```bash
45
-
# Install composer dependences.
47
+
# Install composer dependencies.
46
48
$ composer install -o
47
49
```
48
50
49
-
Install frontend dependences and task runner.
51
+
Install frontend dependencies and task runner.
50
52
51
53
```bash
52
-
# Install node dependences.
54
+
# Install node dependencies.
53
55
$ npm install
54
56
```
55
57
56
58
# Development
57
59
60
+
## Initializing a Theme
61
+
62
+
Starter comes with simple CLI and `gin tonik:shake` command, which allows you to easily fill theme details and information like name, description and project namespace. Simply call `php gin tonik:shake` command in the theme root directory. A setup wizard will guide you through the entire process.
63
+
64
+
```bash
65
+
# Run setup wizard.
66
+
$ php gin tonik:shake
67
+
```
68
+
58
69
## Compiling Assets
59
70
60
71
Theme uses [Laravel Elixir](https://laravel.com/docs/5.3/elixir) to compile it's scripts and stylesheets.
This starter theme introduces "easy to follow" folder structure, which enforce to divide your theme logic into separate files.
86
+
This starter theme introduces "easy to follow" folder structure, which enforces to divide your theme logic into separate files.
76
87
77
88
```
78
89
themes # — Root of your theme
@@ -121,4 +132,4 @@ themes # — Root of your theme
121
132
122
133
## USAGE.md Boilerplate
123
134
124
-
[USAGE.md](https://github.com/tonik/tonik/blob/master/USAGE.md) provides "How to use" guide for themes created with this starter. Remember to properly fill this file before finalising project. Your clients will be grateful.
135
+
[USAGE.md](https://github.com/tonik/tonik/blob/master/USAGE.md) provides "How to use" guide for themes created with this starter. Remember to properly fill this file before finalizing the project. Your clients will be grateful.
0 commit comments