Skip to content

Commit 29d1a61

Browse files
committed
Fix README documentation on specs
Closes #274 Replaces all documentation referencing the `bacon` testing framework with equivalent documentation explaining the usage of `rspec`.
1 parent 522d136 commit 29d1a61

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.rdoc

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Note that some aspects of the library (such as networking, storage, etc.) need
2929
additional dependencies which are not specified in the gemspec. The core requirements are
3030
intentionally kept to a minimum, so nobody has to install unneeded dependencies.
3131

32-
* +bacon+ to run the specs
32+
* +rspec+ to run the specs
3333
* +scrypt+ to use a much faster scrypt hash implementation for Litecoin
3434

3535
If you would like to install using Bundler, put it in your Gemfile and run bundle install
@@ -169,16 +169,29 @@ The specs are also a good place to see how something works.
169169

170170
== Specs
171171

172-
The specs can be run with
172+
Specs require libsecp256k1 in order to be fully run. Therefore, the first step
173+
in running the specs is to build this library if you haven't already:
173174

174-
rake bacon
175+
rake build_libsecp256k1
176+
177+
The majority of specs can be run with
178+
179+
rake rspec
175180

176181
or, if you want to run a single spec
177182

178-
ruby spec/bitcoin/bitcoin_spec.rb
183+
bundle exec rspec spec/bitcoin/bitcoin_spec.rb
179184

180185
If you make changes to the code or add functionality, please also add specs.
181186

187+
To run specs for changes that monkey patch significant functionality, you
188+
should run the specs individually. For example, to run the Dogecoin specs:
189+
190+
rake coin_spec[dogecoin]
191+
192+
If support is added for any new coins a corresponding coin spec should also be
193+
added to test specific functionality of that coin.
194+
182195
== Development
183196

184197
Any help or feedback is greatly appreciated! From getting knee-deep into elliptic-curve acrobatics,

0 commit comments

Comments
 (0)