Skip to content

Commit

Permalink
Refactor readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
danlucraft committed Sep 29, 2010
1 parent 39cc106 commit 01ee9cd
Showing 1 changed file with 17 additions and 30 deletions.
47 changes: 17 additions & 30 deletions README.md
@@ -1,7 +1,6 @@
{Redcar}
========

by Daniel Lucraft
http://RedcarEditor.com/

## DESCRIPTION
Expand All @@ -15,63 +14,51 @@ You must have Java installed. You will also need to run these commands for each
$ sudo gem install redcar
$ redcar install

NB the install will take a minute or so to complete as it has to download
about 15MB of jar files.
NB the install will take a minute or so to complete as it has to download about 15MB of jar files.

## USAGE

Run

$ redcar --help

for a list of options.
$ redcar

## PROBLEMS?

* Irc at #redcar on irc.freenode.net
* Mailing list at http://groups.google.com/group/redcar-editor

## INSTALLING FROM SOURCE

If you want to contribute to Redcar, you can install it from the source code.

If you're running Windows, as a prerequisite, you'll need to install the
rubyzip gem:
If you're running Windows, as a prerequisite, you'll need to install the rubyzip gem:

$ gem install rubyzip

You will need Ant installed. You will also need RSpec, Cucumber and JSON-JRuby
installed as JRuby gems.

$ jruby -S gem install rspec cucumber json-jruby

Download from github, checkout the submodules and build JavaMateView.
Download from github, checkout the submodules and install the jars.

$ git clone git://github.com/redcar/redcar.git
$ cd redcar
$ git submodule init
$ git submodule update
$ jruby bin/redcar install
$ ruby bin/redcar install

To run on Linux and Windows:
To run:

$ jruby bin/redcar

To run on OSX:

$ jruby -J-XstartOnFirstThread bin/redcar

You may also need to install the rake, rspec and cucumber gems.
$ ruby bin/redcar

## UPDATING A SOURCE BUILD

If you are running a source version of Redcar and you have pulled changes from
master, then you may have to update your jars by updating and rebuilding:
If you are running a source version of Redcar and you have pulled changes from master, then you may have to update your repo:

$ git submodule update
$ jruby -S rake build
$ ruby bin/redcar install

## PROBLEMS?
## TESTS

* Irc at #redcar on irc.freenode.net
* Mailing list at http://groups.google.com/group/redcar-editor
NB. Redcar features won't run with Cucumber 0.9.0 yet. They are known to work with 0.8.5.

## TESTS
To run the tests you need JRuby installed. You also need rspec and cucumber installed as Jruby gems. See jruby.org for this, or install with rvm.

To run all specs and features:

Expand Down

0 comments on commit 01ee9cd

Please sign in to comment.