README.md in cf3-0.0.1 vs README.md in cf3-0.0.2
- old
+ new
@@ -5,31 +5,55 @@
Very much derived from [context-free.rb][] by Jeremy Ashkenas this version is updated to be more in line with CF3 and ruby 1.9 syntax. Tested as working with last rubygems release of ruby-processing (v 1.0.11) as well as the current [version][] (v 2.1.0).
[context-free.rb]:https://github.com/jashkenas/context_free/
[version]:https://github.com/monkstone/ruby-processing/releases/
## Installation
-Add this line to your application's Gemfile:
+To use this library you need install jruby (preferably jruby-1.7.4+), you will also need [ruby-processing][] to be installed (minimum version 1.0.11, preferred version 2.1.0). There are three ways you can install this library:-
- gem 'cf3ruby'
+***rake test and gem install***
-And then execute:
+Either clone this repository, or download a [snapshot][].
- $ bundle
+```bash
+cd cf3ruby
+jruby -S rake test # builds and tests gem (mouse click on frame for test image to show)
+jruby -S gem install cf3-0.0.1.gem # may need sudo access
+```
-Or install it yourself as:
+***local bundle install***
- $ gem install cf3
+Either clone this repository, or download a [snapshot].
+```bash
+cd cf3
+bundle install
+```
+
+***gem install from rubygems***
+```bash
+gem install cf3
+```
+it couldn't be easier could it?
+
## Usage
-TODO: Write usage instructions here
+Extract the included samples to your home directory
+```bash
+jruby -S cf3samples
+```
+As for running ruby-processing, it requires the external jruby flag
+```bash
+rp5 run --jruby city.rb # this is why you should install both ruby-processing and cf3ruby using jruby
+
+```
+You should read the [ruby-processing_documentation][] on using rubygems.
+
## Contributing
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[Contributing][]
+[contributing]:CONTRIBUTING.md
+[ruby-processing_documentation]:https://github.com/jashkenas/ruby-processing/wiki/Using-Rubygems/
+[snapshot]:https://github.com/monkstone/cf3ruby/releases
