Skip to content

Latest commit

 

History

History
95 lines (52 loc) · 2.19 KB

README.md

File metadata and controls

95 lines (52 loc) · 2.19 KB

{Redcar}

http://RedcarEditor.com/

DESCRIPTION

A pure Ruby text editor running on JRuby.

INSTALLATION

You must have Java installed [1]. You will also need to run these commands for each user on your computer that needs access to Redcar.

$ sudo gem install redcar
$ redcar install

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

[1] Sun Java or OpenJDK work. Gcj is known not to work.

USAGE

Run

$ redcar

PROBLEMS?

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:

$ gem install rubyzip

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
$ ruby bin/redcar install

To run:

$ 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 repo:

$ git submodule update
$ ruby bin/redcar install

TESTS

NB. Redcar features are known to work with Cucumber 0.9.2, and known NOT to work with Cucumber < 0.9

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:

$ jruby -S rake

NB. You must leave the test window focussed while the features run. Some of the tests will fail if the test process is in the background.

TESTS (specs)

On OSX:

$ jruby -J-XstartOnFirstThread -S spec plugins/#{plugin_name}/spec/

On Linux:

$ jruby -S spec plugins/#{plugin_name}/spec/

TESTS (features)

On OSX:

$ jruby -J-XstartOnFirstThread bin/cucumber plugins/#{plugin_name}/features

On Linux:

$ jruby bin/cucumber plugins/#{plugin_name}/features/

LICENSE

Redcar is copyright 2007-2010 Daniel Lucraft and contributors. It is licensed under the GPL2. See the included LICENSE file for details.