Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.36 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.36 KB
Raw

Genesis Sample Theme

GitHub project link: https://github.com/studiopress/genesis-sample/.

Installation Instructions

  1. Upload the Genesis Sample theme folder via FTP to your wp-content/themes/ directory. (The Genesis parent theme needs to be in the wp-content/themes/ directory as well.)
  2. Go to your WordPress dashboard and select Appearance.
  3. Activate the Genesis Sample theme.
  4. Inside your WordPress dashboard, go to Genesis > Theme Settings and configure them to your liking.

Theme Support

Please visit https://my.studiopress.com/help/ for theme support.

For Developers

The version of Genesis Sample on GitHub includes tooling to check code against WordPress standards. To use it:

  1. Install Composer globally on your development machine. See Composer setup steps.
  2. In the command line, change directory to the Genesis Sample folder.
  3. Type the command composer install to install PHP development dependencies.
  4. Type composer phpcs to run coding standards checks.

You'll see output highlighting issues with PHP files that do not conform to Genesis Sample coding standards.

npm scripts

Scripts are also provided to help with CSS linting, CSS autoprefixing, and creation of pot language files. To use them:

  1. Install Node.js, which also gives you the Node Package Manager (npm).
  2. In the command line, change directory to the Genesis Sample folder.
  3. Type the command npm install to install dependencies.

You can then type any of these commands:

  • npm run autoprefixer to add and remove vendor prefixes in style.css.
  • npm run makepot to regenerate the languages/genesis-sample.pot file.
  • npm run lint:css to generate a report of style violations for style.css.
  • npm run zip to create a genesis-sample.zip of the current branch. Excludes files marked export-ignore in .gitattributes.

Packaging for distribution

  1. Follow the install instructions for npm scripts above.
  2. Switch to the git branch you plan to distribute.
  3. Bump version numbers manually and commit those changes.
  4. Type npm run zip to create genesis-sample.zip. Files marked export-ignore in .gitattributes are excluded from the zip.

The zip command is an alias for git archive -o genesis-sample.zip HEAD.