aboutsummaryrefslogtreecommitdiffstats
path: root/doc/development/SETUP.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/development/SETUP.md')
-rw-r--r--doc/development/SETUP.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/development/SETUP.md b/doc/development/SETUP.md
new file mode 100644
index 00000000..10f8dd30
--- /dev/null
+++ b/doc/development/SETUP.md
@@ -0,0 +1,29 @@
+# Development setup
+
+Bundler doesn't use a Gemfile to list development dependencies, because when we tried it we couldn't tell if we were awake or it was just another level of dreams. To work on Bundler, you'll probably want to do a couple of things.
+
+1. Install `groff-base` and `graphviz` packages using your package manager, e.g for ubuntu
+
+ $ sudo apt-get install graphviz groff-base -y
+
+ and for OS X (with brew installed)
+
+ $ brew install graphviz homebrew/dupes/groff
+
+2. Install Bundler's development dependencies
+
+ $ bin/rake spec:deps
+
+3. Run the test suite, to make sure things are working
+
+ $ bin/rake spec
+
+4. Set up a shell alias to run Bundler from your clone, e.g. a Bash alias:
+
+ $ alias dbundle='BUNDLE_TRAMPOLINE_DISABLE=1 ruby -I /path/to/bundler/lib /path/to/bundler/exe/bundle'
+
+ The `BUNDLE_TRAMPOLINE_DISABLE` environment variable ensures that the version of Bundler in `/path/to/bundler/lib` will be used. Without that environment setting, Bundler will automatically download, install, and run the version of Bundler listed in `Gemfile.lock`. With that set up, you can test changes you've made to Bundler by running `dbundle`, without interfering with the regular `bundle` command.
+
+## Debugging with `pry`
+
+To dive into the code with Pry: `RUBYOPT=-rpry dbundle` to require pry and then run commands.