Skip to content

Commit

Permalink
Polished installation instructions and GFM markup
Browse files Browse the repository at this point in the history
  • Loading branch information
gioele committed Apr 19, 2010
1 parent 05fd821 commit 5e6b3e0
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Expand Up @@ -7,34 +7,36 @@ http://github.com/rawr/rawr


DESCRIPTION
--------------
-----------

Rawr is a packaging solution for JRuby applications. Rawr comes in two pieces, a
rawr command that creates a Java "main" file in your application and a
configuration file that will be used by Rawr to build the final jar and a rake
file that you can include into your project to do the building of the project.
Rawr is a packaging solution for JRuby applications. Rawr comes in two
pieces:

* a `rawr` command that creates a Java _main_ file in your application
and a configuration file that will be used by Rawr to build the final jar;
* a Rake task file that you can include into your project's Rakefile to
automate the creation of the packaged application.

SYNOPSIS
--------

rawr install
rake rawr:jar
java -jar package/jar/your_jar_file.jar
rawr install
rake rawr:jar
java -jar package/jar/your_jar_file.jar

REQUIREMENTS
------------

* jruby
* JRuby >= 1.4
* javac
* jar
* rake
* Rake

INSTALL
----------
-------

* sudo gem install rawr
sudo gem install rawr

LICENSE
-------

Rawr is released under the Ruby License.
Rawr is released under the Ruby License.

0 comments on commit 5e6b3e0

Please sign in to comment.