Skip to content
Browse files

bundled software license info and some usage documentation

  • Loading branch information...
1 parent 1c45043 commit 6b41dff63079f1272d61f93508870bd0ed15b458 @fabiokung committed May 10, 2008
Showing with 32 additions and 10 deletions.
  1. +10 −0 Licenses.txt
  2. +22 −10 README.txt
View
10 Licenses.txt
@@ -25,3 +25,13 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
= Additional Bundled Software
+JRuby-Rack (jruby-rack-*.jar) is distributed under the terms of the
+MIT license. See http://svn.codehaus.org/jruby-contrib/trunk/rack/LICENSE.txt
+for details.
+
+Jetty (jetty-*.jar) is distributed under the terms of the Apache 2.0 License.
+See http://jetty.mortbay.org/jetty-6/LICENSE.txt for details.
+
+Servlet API 2.5, a.k.a JSR-154, (servlet-api-2.5-*.jar) is distributed
+under the terms of the Berkeley License. See http://developers.sun.com/license/berkeley_license.html
+for details.
View
32 README.txt
@@ -8,35 +8,47 @@ jetty_rails aims to run any Warbler based jruby on rails applications with Jetty
This project is useful for people developing jruby on rails apps that can not use mongrel for development. Rails applications integrated with servlet based applications in the same context would be a reasonable reason.
-The project has born from my own needs. I needed to run JForum (http://jforum.net) on the same context of my jruby on rails application. I wanted to integrate HttpSessions (avoiding single sign on) and use ServletContext in-memory cache store.
+The project has born from my own needs. I needed to run JForum (http://jforum.net) on the same context of my jruby on rails application. I had also to integrate HttpSessions (avoiding single sign on) and use ServletContext in-memory cache store.
== FEATURES/PROBLEMS:
+* Uses "JRuby Rack":http://wiki.jruby.org/wiki/JRuby_Rack
* FIX (list of features or problems)
-== SYNOPSIS:
+=== Known Issues
-* FIX (code sample of usage)
+To generate coverage report with jruby (>= 1.1) follow
+instructions from http://www.ruby-forum.com/topic/146252 and run
+(inside jetty-rails root dir):
-== REQUIREMENTS:
+jruby -S rake rcov
+
+== USAGE:
+
+ cd myrailsapp
+ jruby -S jetty_rails
+
+ you can use the --help option to see more usage details:
+
+ jruby -S jetty_rails --help
-* FIX (list of requirements)
+== REQUIREMENTS:
-* To generate coverage report with jruby (>= 1.1) follow
-http://www.ruby-forum.com/topic/146252 and:
+jetty-rails requires jruby (>=1.1). Please make sure you already have
+it properly installed and inserted in your PATH environment variable.
-jruby -S rake rcov
+"Installing JRuby Instructions":http://wiki.jruby.org/wiki/Getting_Started
== INSTALL:
-* FIX (sudo gem install, anything else)
+ jruby -S gem install jetty-rails
== LICENSE:
Jetty Rails is distributed under the terms of The MIT License.
Copyright (c) 2008 Fabio Kung <fabio.kung@gmail.com>
-Read more details in the bundled Licenses.txt file. There are other
+Read more details in the bundled +Licenses.txt+ file. There are other
pieces of software bundled with jetty-rails. Before using jetty-rails,
make sure you agree with all of them.

0 comments on commit 6b41dff

Please sign in to comment.
Something went wrong with that request. Please try again.