From 7900dd37488ab5eb0eb1d8ff1f1157f58347c0e1 Mon Sep 17 00:00:00 2001 From: Ben Word Date: Sun, 13 Feb 2022 21:31:37 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20simplify=20acorn=20notes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1d1f584..909be7e 100644 --- a/README.md +++ b/README.md @@ -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: +- [Acorn](https://docs.roots.io/acorn/2.x/installation/) >= 2.0.0-beta.9.1 - [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) - [Composer](https://getcomposer.org/download/) - [Node.js](http://nodejs.org/) >= 16 - [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 **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 ``` -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