https://github.com/eclectic-coding/modulus-pro2

https://github.com/eclectic-coding/modulus-pro2

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/eclectic-coding/modulus-pro2
• Owner: eclectic-coding
• License: mit
• Created: 2020-12-15T21:40:27.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-20T00:04:12.000Z (almost 2 years ago)
• Last Synced: 2024-12-01T12:07:40.701Z (27 days ago)
• Language: PHP
• Homepage:
• Size: 1.61 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/studiopress/genesis-sample/) includes tooling to check code against WordPress standards. To use it:

1. Install Composer globally on your development machine. [See Composer setup steps](https://getcomposer.org/doc/00-intro.md#downloading-the-composer-executable).

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.

Run `composer phpcbf` if you see “phpcbf can fix the x marked sniff violations automatically” in the output of `composer phpcs`.

### 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](https://nodejs.org/), 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 lint:js` to generate a report of style violations for JavaScript files.

- `npm run fix:js` to fix any JavaScript style violations that can be corrected automatically.

- `npm run zip` to create a genesis-sample.zip. Files in the `excludes` array in `scripts/makezip.js` are omitted.

### 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 in the `excludes` array in `scripts/makezip.js` are omitted from the zip. `filename.md` files will be renamed to `filename.txt`.