Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.23 KB

USAGE.md

File metadata and controls

69 lines (46 loc) · 2.23 KB
Raw

This is a template file with instructions about usage of this theme. You should fill it accordingly and distribute along with theme files.

Theme Installation and Usage

You should be familiar with the command line to efficiently install this theme. Required is also a knowledge about Composer and NPM package managers.

Requirements

This theme follow WordPress recommended requirments. Your server must fulfill requirements:

  • At least PHP >= 7.0
  • MySQL >=5.6 or MariaDB >=10.0
  • The mod_rewrite Apache module

Make sure you have all these dependences installed before moving on:

  • WordPress >= 4.7
  • Composer
  • Node.js

Dependences

Theme is based on Tonik WordPress Starter Theme. It has a few PHP dependencies, they are extracted to separate packages for easy installation and managing via Composer.

  • tonik/gin (required) - Theme foundation which provides all custom functionalities
  • tonik/cli (optional) - Simple CLI for initiating theme

Installation

Download or clone theme repository to the wp-content/themes directory.

# @ /wp-content/themes
# Clone repository to the themes folder.
$ git clone git@github.com:<repository>/<theme-name>.git <theme-name>

Go into theme directory and run following commands to resolve dependencies and build a theme.

# @ /wp-content/themes
# Change directory to the cloned folder.
$ cd <theme-name>

# @ /wp-content/themes/<theme-name>
# Install required composer dependences (without these needed only to development).
$ composer install -o --no-devs

# @ /wp-content/themes/<theme-name>
# Install required npm dependences for building a theme.
$ npm install

# @ /wp-content/themes/<theme-name>
# Build theme assets for production.
$ npm run prod

Required Plugins

Here is a list of theme's required and recommended plugins. They can be installed via "Plugins" dashboard or manually uploaded to the wp-content/plugins directory.

Familiar with WP-CLI? Install plugins via command line:

wp plugin install <plugin-name> --activate