diff options
| author | The Bundler Bot <bot@bundler.io> | 2017-10-19 08:30:35 +0000 |
|---|---|---|
| committer | The Bundler Bot <bot@bundler.io> | 2017-10-19 08:30:35 +0000 |
| commit | f093e405a8e10bafa0b5d4621069a0b7ad86c37f (patch) | |
| tree | b6d705573941e248a5251b70bfbda7c148df74ec /doc | |
| parent | 1a13452d51ea8842b747545d68653a5aaae2bb70 (diff) | |
| parent | 80b81c45d71ef9260decaae85dba5c3168642f8b (diff) | |
| download | bundler-f093e405a8e10bafa0b5d4621069a0b7ad86c37f.tar.gz | |
Auto merge of #6100 - bundler:colby/development-doc, r=segiddins
improve development setup docs and remove redundant quotes
### What was the end-user problem that led to this PR?
Some distrobutions of linux do not ship with the `col` command which `ronn` requires. And there are also some code blocks that don't need to quoted.
### What is your fix for the problem, implemented in this PR?
Update the developer docs to include instruction to install the package that has the `col` command and remove the code block quotes that don't need to be there.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/SETUP.md | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/development/SETUP.md b/doc/development/SETUP.md index cebe925c1b..a05f9861a1 100644 --- a/doc/development/SETUP.md +++ b/doc/development/SETUP.md @@ -4,25 +4,29 @@ Bundler doesn't use a Gemfile to list development dependencies, because when we 1. [Fork the Bundler repo](https://github.com/bundler/bundler), and clone the fork onto your machine. ([Follow this tutorial](https://help.github.com/articles/fork-a-repo/) for instructions on forking a repo.) -2. Install `groff-base` and `graphviz` packages using your package manager, e.g for Ubuntu: +2. Install `groff-base` and `graphviz` packages using your package manager: - `$ sudo apt-get install graphviz groff-base -y` + $ sudo apt-get install graphviz groff-base -y - and for OS X (with brew installed): + And for OS X (with brew installed): - `$ brew install graphviz homebrew/dupes/groff` + $ brew install graphviz homebrew/dupes/groff -3. Install Bundler's development dependencies: +3. You may also have to install the `bsdmainutils` package on linux if your distribution does not include the `col` command. - `$ bin/rake spec:deps` + $ sudo apt-get install bsdmainutils -y -4. Run the test suite, to make sure things are working: +4. Install Bundler's development dependencies: - `$ bin/rake spec` + $ bin/rake spec:deps -5. Set up a shell alias to run Bundler from your clone, e.g. a Bash alias ([follow these instructions](https://www.moncefbelyamani.com/create-aliases-in-bash-profile-to-assign-shortcuts-for-common-terminal-commands/) for adding aliases to your `~/.bashrc` profile): +5. Run the test suite, to make sure things are working: - `$ alias dbundle='/path/to/bundler/repo/bin/bundle'` + $ bin/rake spec + +6. Set up a shell alias to run Bundler from your clone, e.g. a Bash alias ([follow these instructions](https://www.moncefbelyamani.com/create-aliases-in-bash-profile-to-assign-shortcuts-for-common-terminal-commands/) for adding aliases to your `~/.bashrc` profile): + + $ alias dbundle='/path/to/bundler/repo/bin/bundle ## Debugging with `pry` |