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.

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

Add create plugins dir to install instructions #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Terminus plugin to open any Pantheon site database using a SQL GUI client.

## Installation

## Prerequisites
Plugins directory must exist inside the terminus directory
`mkdir ~/.terminus/plugins`
Copy link
Contributor

@uberhacker uberhacker Mar 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be noted this is only necessary for Terminus 2.x. It might be easier to include it on the same line as composer create-project ... like below:

mkdir -p ~/.terminus/plugins && composer create-project --stability=beta -d ~/.terminus/plugins/ terminus-plugin-project/terminus-pancakes-plugin:~2

The install section can be updated for Terminus 3.x also. See https://github.com/pantheon-systems/terminus-plugin-example#installation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tekNorah: Please add this to the Terminus v2 section and I can get this merged.


### Composer

For quick install using Composer, install using:
Expand Down