Code
/
pressbooks-aldine
7
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Update readme.

pull/3/merge
Ned Zimmerman 7 years ago
parent
024f79f235
commit
eb07cb26fc
No known key found for this signature in database
GPG Key ID: FF56334A013120CA
1 changed files with 8 additions and 54 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 62
      README.md

62
README.md
Unescape View File

@ -1,11 +1,6 @@
# [Sage](https://roots.io/sage/) # Aldine
[![Packagist](https://img.shields.io/packagist/vpre/roots/sage.svg?style=flat-square)](https://packagist.org/packages/roots/sage)
[![devDependency Status](https://img.shields.io/david/dev/roots/sage.svg?style=flat-square)](https://david-dm.org/roots/sage#info=devDependencies)
[![Build Status](https://img.shields.io/travis/roots/sage.svg?style=flat-square)](https://travis-ci.org/roots/sage)
Sage is a WordPress starter theme with a modern development workflow. Aldine is the new root theme for [Pressbooks](https://github.com/pressbooks/pressbooks), based on [Sage](https://roots.io/sage/)
**Sage 9 is in active development and is currently in beta. The `master` branch tracks Sage 9 development. If you want a stable version, use the [latest Sage 8 release](https://github.com/roots/sage/releases/latest).**
## Features ## Features
@ -13,22 +8,14 @@ Sage is a WordPress starter theme with a modern development workflow.
* ES6 for JavaScript * ES6 for JavaScript
* [Webpack](https://webpack.github.io/) for compiling assets, optimizing images, and concatenating and minifying files * [Webpack](https://webpack.github.io/) for compiling assets, optimizing images, and concatenating and minifying files
* [Browsersync](http://www.browsersync.io/) for synchronized browser testing * [Browsersync](http://www.browsersync.io/) for synchronized browser testing
* [Laravel Blade](https://laravel.com/docs/5.3/blade) as a templating engine * [Laravel Blade](https://laravel.com/docs/5.4/blade) as a templating engine
* [Controller](https://github.com/soberwp/controller) for passing data to Blade templates * [Controller](https://github.com/soberwp/controller) for passing data to Blade templates
* CSS framework options:
* [Bootstrap 4](http://getbootstrap.com/)
* [Foundation](http://foundation.zurb.com/)
* [Tachyons](http://tachyons.io/)
* None (blank slate)
* Font Awesome (optional)
See a working example at [roots-example-project.com](https://roots-example-project.com/).
## Requirements ## Requirements
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.7 * [WordPress](https://wordpress.org/) >= 4.8
* [PHP](http://php.net/manual/en/install.php) >= 5.6.4 * [PHP](http://php.net/manual/en/install.php) >= 5.6.4
* [Composer](https://getcomposer.org/download/) * [Composer](https://getcomposer.org/download/)
* [Node.js](http://nodejs.org/) >= 6.9.x * [Node.js](http://nodejs.org/) >= 6.9.x
@ -36,24 +23,17 @@ Make sure all dependencies have been installed before moving on:
## Theme installation ## Theme installation
Install Sage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of your theme): Install Aldine using Composer from your WordPress themes directory:
```shell ```shell
# @ app/themes/ or wp-content/themes/ # @ app/themes/ or wp-content/themes/
$ composer create-project roots/sage your-theme-name dev-master $ composer require pressbooks/pressbooks-aldine
``` ```
During theme installation you will have the options to:
* Update theme headers (theme name, description, author, etc.)
* Select a CSS framework (Bootstrap, Foundation, Tachyons, none)
* Add Font Awesome
* Configure Browsersync (path to theme, local development URL)
## Theme structure ## Theme structure
```shell ```shell
themes/your-theme-name/ # → Root of your Sage based theme themes/pressbooks-aldine/ # → Theme root
├── app/ # → Theme PHP ├── app/ # → Theme PHP
│ ├── lib/Sage/ # → Blade implementation, asset manifest │ ├── lib/Sage/ # → Blade implementation, asset manifest
│ ├── admin.php # → Theme customizer setup │ ├── admin.php # → Theme customizer setup
@ -84,41 +64,15 @@ themes/your-theme-name/ # → Root of your Sage based theme
└── vendor/ # → Composer packages (never edit) └── vendor/ # → Composer packages (never edit)
``` ```
## Theme setup
Edit `app/setup.php` to enable or disable theme features, setup navigation menus, post thumbnail sizes, and sidebars.
## Theme development ## Theme development
* Run `yarn` from the theme directory to install dependencies * Run `yarn` from the theme directory to install dependencies
* Update `resources/assets/config.json` settings: * Update `resources/assets/config.json` settings:
* `devUrl` should reflect your local development hostname * `devUrl` should reflect your local development hostname
* `publicPath` should reflect your WordPress folder structure (`/wp-content/themes/sage` for non-[Bedrock](https://roots.io/bedrock/) installs) * `publicPath` should reflect your WordPress folder structure (`/wp-content/themes/pressbooks-aldine` for non-[Bedrock](https://roots.io/bedrock/) installs)
### Build commands ### Build commands
* `yarn run start` — Compile assets when file changes are made, start Browsersync session * `yarn run start` — Compile assets when file changes are made, start Browsersync session
* `yarn run build` — Compile and optimize the files in your assets directory * `yarn run build` — Compile and optimize the files in your assets directory
* `yarn run build:production` — Compile assets for production * `yarn run build:production` — Compile assets for production
## Documentation
Sage 8 documentation is available at [https://roots.io/sage/docs/](https://roots.io/sage/docs/).
Sage 9 documentation is currently in progress and can be viewed at [https://github.com/roots/docs/tree/sage-9/sage](https://github.com/roots/docs/tree/sage-9/sage).
Controller documentation is available at [https://github.com/soberwp/controller#usage](https://github.com/soberwp/controller#usage).
## Contributing
Contributions are welcome from everyone. We have [contributing guidelines](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md) to help you get started.
## Community
Keep track of development and community news.
* Participate on the [Roots Discourse](https://discourse.roots.io/)
* Follow [@rootswp on Twitter](https://twitter.com/rootswp)
* Read and subscribe to the [Roots Blog](https://roots.io/blog/)
* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)
* Listen to the [Roots Radio podcast](https://roots.io/podcast/)

Write Preview
Loading…
Cancel
Save