Browse Source

Update readme.

pull/3/merge
Ned Zimmerman 7 years ago
parent
commit
4245d1a624
  1. 12
      README.md

12
README.md

@ -17,15 +17,16 @@ Aldine is the new root theme for [Pressbooks](https://github.com/pressbooks/pres
Make sure all dependencies have been installed before moving on: Make sure all dependencies have been installed before moving on:
* [WordPress](https://wordpress.org/) >= 4.8 * [PHP](http://php.net/manual/en/install.php) >= 7.0
* [PHP](http://php.net/manual/en/install.php) >= 5.6.4
* [Composer](https://getcomposer.org/download/) * [Composer](https://getcomposer.org/download/)
* [WordPress](https://wordpress.org/) >= 4.8.1
* [Pressbooks](https://github.com/pressbooks/pressbooks) >= 4.0
* [Node.js](http://nodejs.org/) >= 6.9.x * [Node.js](http://nodejs.org/) >= 6.9.x
* [Yarn](https://yarnpkg.com/en/docs/install) * [Yarn](https://yarnpkg.com/en/docs/install)
## Theme installation ## Theme installation
Install Aldine using Composer from your WordPress themes directory: Install Aldine using Composer from your Pressbooks themes directory:
```shell ```shell
# @ app/themes/ or wp-content/themes/ # @ app/themes/ or wp-content/themes/
@ -37,11 +38,13 @@ $ composer require pressbooks/pressbooks-aldine
```shell ```shell
themes/pressbooks-aldine/ # → Theme root themes/pressbooks-aldine/ # → Theme root
├── app/ # → Theme PHP ├── app/ # → Theme PHP
│ ├── lib/Sage/ # → Blade implementation, asset manifest │ ├── controllers/ # → Controller files
│ ├── widgets/ # → Custom widget classes
│ ├── admin.php # → Theme customizer setup │ ├── admin.php # → Theme customizer setup
│ ├── filters.php # → Theme filters │ ├── filters.php # → Theme filters
│ ├── helpers.php # → Helper functions │ ├── helpers.php # → Helper functions
│ └── setup.php # → Theme setup │ └── setup.php # → Theme setup
│ └── widgets.php # → Widget initialization
├── composer.json # → Autoloading for `app/` files ├── composer.json # → Autoloading for `app/` files
├── composer.lock # → Composer lock file (never edit) ├── composer.lock # → Composer lock file (never edit)
├── dist/ # → Built theme assets (never edit) ├── dist/ # → Built theme assets (never edit)
@ -55,7 +58,6 @@ themes/pressbooks-aldine/ # → Theme root
│ │ ├── images/ # → Theme images │ │ ├── images/ # → Theme images
│ │ ├── scripts/ # → Theme JS │ │ ├── scripts/ # → Theme JS
│ │ └── styles/ # → Theme stylesheets │ │ └── styles/ # → Theme stylesheets
│ ├── controllers/ # → Controller files
│ ├── functions.php # → Composer autoloader, theme includes │ ├── functions.php # → Composer autoloader, theme includes
│ ├── index.php # → Never manually edit │ ├── index.php # → Never manually edit
│ ├── screenshot.png # → Theme screenshot for WP admin │ ├── screenshot.png # → Theme screenshot for WP admin

Loading…
Cancel
Save