Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

Commit 29dc9af

Browse files
Updates license to MIT; Adds section about initializina a theme
1 parent 7d08720 commit 29dc9af

File tree

3 files changed

+28
-10
lines changed

3 files changed

+28
-10
lines changed

LICENSE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) Tonik
2+
3+
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.

README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Tonik
22

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:
3+
[![Build Status](https://travis-ci.org/tonik/tonik.svg?branch=master)](https://travis-ci.org/tonik/tonik)
4+
5+
### Tonik Starter Theme aims to modernize, organize and simplify some aspects of WordPress theme development. Take a look at what is waiting for you:
46

57
- Child theme friendly **Autoloader**
68
- Simple **Theme Service Container**
@@ -30,7 +32,7 @@ Create project via `composer create-project` composer command.
3032
$ composer create-project tonik/tonik <theme-name>
3133
```
3234

33-
You can also directly download or clone repository to the `wp-content/themes` directory.
35+
You can also directly download or clone the repository to the `wp-content/themes` directory.
3436

3537
```bash
3638
# Clone repository to the <theme-name> folder.
@@ -39,22 +41,31 @@ $ git clone [email protected]:tonik/tonik.git <theme-name>
3941

4042
## Resolving Dependences
4143

42-
Install back-end dependeces and generate autoloading file.
44+
Install back-end dependencies and generate an autoloading file.
4345

4446
```bash
45-
# Install composer dependences.
47+
# Install composer dependencies.
4648
$ composer install -o
4749
```
4850

49-
Install frontend dependences and task runner.
51+
Install frontend dependencies and task runner.
5052

5153
```bash
52-
# Install node dependences.
54+
# Install node dependencies.
5355
$ npm install
5456
```
5557

5658
# Development
5759

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+
5869
## Compiling Assets
5970

6071
Theme uses [Laravel Elixir](https://laravel.com/docs/5.3/elixir) to compile it's scripts and stylesheets.
@@ -63,7 +74,7 @@ Theme uses [Laravel Elixir](https://laravel.com/docs/5.3/elixir) to compile it's
6374
# Run compile tasks.
6475
$ gulp
6576

66-
# Watch for file changes and rund compile tasks.
77+
# Watch for file changes and run compile tasks.
6778
$ gulp watch
6879

6980
# Compile assets for production.
@@ -72,7 +83,7 @@ $ gulp --production
7283

7384
## Folders and Files Structure
7485

75-
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.
7687

7788
```
7889
themes # — Root of your theme
@@ -121,4 +132,4 @@ themes # — Root of your theme
121132

122133
## USAGE.md Boilerplate
123134

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.

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "tonik/tonik",
33
"description": "Modern WordPress Starter Theme",
44
"keywords": ["tonik", "theme", "gin", "wordpress", "wordpress-starter-theme", "wordpress-theme"],
5-
"license": "GPL-2.0+",
5+
"license": "MIT",
66
"type": "wordpress-theme",
77
"require": {
88
"php": ">=5.6",

0 commit comments

Comments
 (0)