framework/sage
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 simplify acorn notes

Browse Source
This commit is contained in:
Ben Word
2022-02-13 21:31:37 -06:00
committed by GitHub
parent 52add4944d
commit 7900dd3748
1 changed files with 2 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -55,23 +55,13 @@ However, the amount of effort needed to maintain and develop new features and pr
Make sure all dependencies have been installed before moving on: Make sure all dependencies have been installed before moving on:
- [Acorn](https://docs.roots.io/acorn/2.x/installation/) >= 2.0.0-beta.9.1
- [WordPress](https://wordpress.org/) >= 5.9 - [WordPress](https://wordpress.org/) >= 5.9
- [PHP](https://secure.php.net/manual/en/install.php) >= 7.4.0 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled) - [PHP](https://secure.php.net/manual/en/install.php) >= 7.4.0 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)
- [Composer](https://getcomposer.org/download/) - [Composer](https://getcomposer.org/download/)
- [Node.js](http://nodejs.org/) >= 16 - [Node.js](http://nodejs.org/) >= 16
- [Yarn](https://yarnpkg.com/en/docs/install) - [Yarn](https://yarnpkg.com/en/docs/install)
### Acorn
Although Sage makes use of Acorn, it doesn't ship with it included. This is to give you the flexibility to include it in a way that works best for your environment.
- **[Bedrock](https://github.com/roots/bedrock)** is the recommended way to manage your WordPress installation, themes, and plugins. If you're using Bedrock, you only need to require Acorn as a composer dependency in your Bedrock `composer.json`:
```sh
$ composer require roots/acorn
```
- If Bedrock isn't feasible, then the next best approach is to install Acorn as an **mu-plugin**. This guarantees that it will always be available and someone won't accidentally disable it and break your site. Add the Acorn directory to your `mu-plugins` directory, and make sure you have something to load it automatically, like our [`bedrock-autoloader`](https://github.com/roots/bedrock-autoloader).
- If neither of the preceding options is workable for you, then Acorn can always be installed as a **normal plugin** by putting the Acorn directory in your `plugins` folder. Just remember to activate it!
## Theme installation ## Theme installation
**The `main` branch currently tracks Sage 10 which is in active development. Looking for Sage 9 or the latest Sage 10 beta release? [See releases](https://github.com/roots/sage/releases).** **The `main` branch currently tracks Sage 10 which is in active development. Looking for Sage 9 or the latest Sage 10 beta release? [See releases](https://github.com/roots/sage/releases).**
@@ -89,7 +79,7 @@ To install the latest development version of Sage, add `dev-main` to the end of
$ composer create-project roots/sage your-theme-name dev-main $ composer create-project roots/sage your-theme-name dev-main
``` ```
Make sure that you have Acorn installed. See the "Acorn" section above for instructions. Make sure that you have [Acorn installed](https://docs.roots.io/acorn/2.x/installation/).
## Theme structure ## Theme structure