summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZack Hobson2013-11-21 13:11:23 -0800
committerZack Hobson2013-11-21 13:11:23 -0800
commit97c14cd9ed89e5e5d85dcfb7abb206b4d0ce847a (patch)
treed7716752b18ef8d615ff5116b0ecbf8531ef5af6
parent6c903fd0c4ef000c01ff7a3ece0cf9da27b3530c (diff)
downloadhcl-97c14cd9ed89e5e5d85dcfb7abb206b4d0ce847a.tar.bz2
update HACKING with info about bundler
-rw-r--r--HACKING.markdown21
1 files changed, 8 insertions, 13 deletions
diff --git a/HACKING.markdown b/HACKING.markdown
index 47e6ae1..a2066b8 100644
--- a/HACKING.markdown
+++ b/HACKING.markdown
@@ -1,21 +1,16 @@
# Hacking HCl
-## Rubygems
+## Running the tests
-They're useful so we use them to install our gems. However there's no need to
-explicitly include rubygems in the app. That's up the system to decide. Don't
-require rubygems in the code.
+Use Bundler to install dependencies before you run the tests:
-We require rubygems in the test as a developer convenience.
+ gem install bundler
+ bundle
+ rake test
-## Running HCl in place
+## Running HCl during development
-This is common and supported:
+To run HCl in place (e.g. for testing out local changes) you can use bundle exec:
- ruby -rubygems -Ilib bin/hcl
+ bundle exec bin/hcl
-Don't add dir(__FILE__)/lib to the load path in the binary. Bad manners.
-
-## That's it
-
-That's it. I mostly wrote this to explain why I rolled back certain changes.