README.markdown in andhapp-decoct-1.4.4 vs README.markdown in andhapp-decoct-1.5.4
- old
+ new
@@ -1,29 +1,62 @@
-# Decoct: Quick start Sinatra with Rspec
+Decoct: Quick start Sinatra with Rspec
+=====================================
Decoct is a simple gem that creates a sinatra app directory structure and hooks it up with Rspec.
-## Installing
+Installing
+---------
- # Install the gem:
- gem install andhapp-decoct -s http://gems.github.com (on Windows)
+Install the gem: gem install andhapp-decoct -s http://gems.github.com (on Windows)
-## Caveat
-
- The gem has only been tested on Windows and the reason that could be a problem is because it depends upon other
- gems to work properly. I have a workaround in my mind but it has not been implemented as yet.
+Caveat
+-------
-## Dependencies
-
- The gem depends on the following libraries:
- * rspec
- * ZenTest
- * ruby-snarl
- * redgreen
- * rcov
+The gem has only been tested on Windows and the reason that could be a problem is because it depends upon other
+gems to work properly. I have a workaround in my mind but it has not been implemented as yet.
- Also, in order to use ruby-snarl you should have [Snarl](http://www.fullphat.net/index.php) installed on
- your machine.
- Snarl is a messaging system for windows. This would give you nice visual messages on the status of your tests.
- [Here's](http://thewebfellas.com/blog/2007/12/10/rspec-autotest-and-snarl-on-windows) a nice article if you
- would like to incorporate that into rails projects. Hence, the caveat above.
+Dependencies
+-----------
+
+The gem depends on the following libraries:
+
+* rspec
+* ZenTest
+* ruby-snarl
+* redgreen
+* rcov
+
+Also, in order to use ruby-snarl you should have [Snarl][snarl] installed on
+your machine.
+Snarl is a messaging system for windows. This would give you nice visual messages on the status of your tests.
+[Here's][here] a nice article if you
+would like to incorporate that into rails projects. Hence, the caveat above.
+
+
+Usage
+----
+
+Assuming that you have installed the gem. Use the command line and go to the directory where you would like to create
+the new project and run the following command:
+
+decoct {project-name}
+
+This would create a sinatra project with all the rspec dependencies. If a directory with the same name exists it will
+overwrite it. Just go into the directory on your command line and run the following command:
+
+set RSPEC=true autotest
+
+and finally run the following command:
+
+autotest
+
+
+Issues
+-----
+
+I have spotted one existing issue with it and it is documented here:
+[Decoct - Issue1][issue].
+
+[snarl]: http://www.fullphat.net/index.php
+[here]: http://thewebfellas.com/blog/2007/12/10/rspec-autotest-and-snarl-on-windows
+[issue]: http://github.com/andhapp/decoct/issues
\ No newline at end of file