Skip to content
Newer
Older
100644 96 lines (52 sloc) 2.19 KB
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
1 {Redcar}
2 ========
1113047 @danlucraft Bits of documentation here and there + rake doc tasks
danlucraft authored
3
4 http://RedcarEditor.com/
d3baefe added project metadata
lucraft authored
5
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
6 ## DESCRIPTION
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
7
7282535 @danlucraft Waxed README
danlucraft authored
8 A pure Ruby text editor running on JRuby.
d3baefe added project metadata
lucraft authored
9
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
10 ## INSTALLATION
30b68b2 * Updated install instructions
Daniel Lucraft authored
11
cfa2597 @danlucraft Update README to specify which java distros work
danlucraft authored
12 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.
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
13
8a8ff34 @danlucraft Change the instructions around installation
danlucraft authored
14 $ sudo gem install redcar
a18db88 @mscharley I'm sick of people complaining about sudo not working. This install m…
mscharley authored
15 $ redcar install
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
16
cfa2597 @danlucraft Update README to specify which java distros work
danlucraft authored
17 The install will take a minute or so to complete as it has to download about 15MB of jar files.
18
19 [1] Sun Java or OpenJDK work. Gcj is known not to work.
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
20
3cf6f1a @danlucraft Added usage to README
danlucraft authored
21 ## USAGE
22
23 Run
24
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
25 $ redcar
26
27 ## PROBLEMS?
28
29 * Irc at #redcar on irc.freenode.net
30 * Mailing list at http://groups.google.com/group/redcar-editor
3cf6f1a @danlucraft Added usage to README
danlucraft authored
31
283f1a6 @danlucraft Added instructions for installing from source
danlucraft authored
32 ## INSTALLING FROM SOURCE
33
064cb51 @danlucraft Make it clearer in the README that installing from source is for cont…
danlucraft authored
34 If you want to contribute to Redcar, you can install it from the source code.
f7d9b25 @fcoury Added rubyzip as a prereq for building in Windoze
fcoury authored
35
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
36 If you're running Windows, as a prerequisite, you'll need to install the rubyzip gem:
f7d9b25 @fcoury Added rubyzip as a prereq for building in Windoze
fcoury authored
37
38 $ gem install rubyzip
39
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
40 Download from github, checkout the submodules and install the jars.
283f1a6 @danlucraft Added instructions for installing from source
danlucraft authored
41
0e4deb5 @mscharley Updated URL's in the readme.
mscharley authored
42 $ git clone git://github.com/redcar/redcar.git
283f1a6 @danlucraft Added instructions for installing from source
danlucraft authored
43 $ cd redcar
44 $ git submodule init
45 $ git submodule update
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
46 $ ruby bin/redcar install
283f1a6 @danlucraft Added instructions for installing from source
danlucraft authored
47
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
48 To run:
283f1a6 @danlucraft Added instructions for installing from source
danlucraft authored
49
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
50 $ ruby bin/redcar
3cf6f1a @danlucraft Added usage to README
danlucraft authored
51
aa408a4 @danlucraft Add update instructions to the README
danlucraft authored
52 ## UPDATING A SOURCE BUILD
53
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
54 If you are running a source version of Redcar and you have pulled changes from master, then you may have to update your repo:
aa408a4 @danlucraft Add update instructions to the README
danlucraft authored
55
12ddc0c @mscharley Updated the README, formatting and added mention of json-jruby as a p…
mscharley authored
56 $ git submodule update
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
57 $ ruby bin/redcar install
aa408a4 @danlucraft Add update instructions to the README
danlucraft authored
58
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
59 ## TESTS
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
60
bfd9509 @danlucraft Update README
danlucraft authored
61 NB. Redcar features are known to work with Cucumber 0.9.2, and known NOT to work with Cucumber < 0.9
30b68b2 * Updated install instructions
Daniel Lucraft authored
62
01ee9cd @danlucraft Refactor readme a bit
danlucraft authored
63 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.
a6f558a @danlucraft Removed hacky feature dependency loading code in favour of patching C…
danlucraft authored
64
65 To run all specs and features:
66
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
67 $ jruby -S rake
a6f558a @danlucraft Removed hacky feature dependency loading code in favour of patching C…
danlucraft authored
68
b4f5473 @danlucraft Added a testing note to the readme
danlucraft authored
69 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.
a6f558a @danlucraft Removed hacky feature dependency loading code in favour of patching C…
danlucraft authored
70
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
71 ## TESTS (specs)
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
72
73 On OSX:
74
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
75 $ jruby -J-XstartOnFirstThread -S spec plugins/#{plugin_name}/spec/
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
76
77 On Linux:
78
cf9796a @danlucraft Fixed up install instructions
danlucraft authored
79 $ jruby -S spec plugins/#{plugin_name}/spec/
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
80
81
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
82 ## TESTS (features)
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
83
84 On OSX:
85
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
86 $ jruby -J-XstartOnFirstThread bin/cucumber plugins/#{plugin_name}/features
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
87
88 On Linux:
84375a3 @danlucraft Updated README
danlucraft authored
89
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
90 $ jruby bin/cucumber plugins/#{plugin_name}/features/
84375a3 @danlucraft Updated README
danlucraft authored
91
cdfa7df @danlucraft Add documentation for Redcar module
danlucraft authored
92 ## LICENSE
d3baefe added project metadata
lucraft authored
93
595ca95 @danlucraft Update copyright
danlucraft authored
94 Redcar is copyright 2007-2010 Daniel Lucraft and contributors.
43946fd @danlucraft Simplified the cucumber binary and updated the README with how to run…
danlucraft authored
95 It is licensed under the GPL2. See the included LICENSE file for details.
Something went wrong with that request. Please try again.