Skip to content

Updated readme #18

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

Merged
rimi-itk merged 3 commits into from
Jun 16, 2019
Merged

Updated readme #18

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5f5d81
Updated readme
cableman Mar 29, 2019
251d805
Merge branch 'develop' into feature/readme
rimi-itk Jun 16, 2019
b38089e
Fixed typos
rimi-itk Jun 16, 2019
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
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ There are some simple tricks that makes docker perform better on Mac's. Open the

# Usage

## Requirement for all commands to work.

You need to have some local packages installed via brew for all things to work.

Completions don't work with the bash completion that comes with macOS. So please install a newer version:

```
brew install bash-completion
```

__Note__: You have to follow the instructions brew writes to get it working (use
`brew info bash-completion` to show the info).

The database sync will not work if you don't have a local mysql client installed:

```
brew install mysql-client
```

__Note__: You have to follow the instructions brew writes to get it working (use
`brew info mysql-client` to show the info).


## Templates

The [`templates`](templates/) directory contains templates for adding
Expand Down