Changeset 6047

Show
Ignore:
Timestamp:
11/10/06 18:05:36
Author:
jan
Message:

jerbil readme

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/README

    r6042 r6047  
    1 = Jerbil -- Java build system based on Rake[http://rake.rubyforge.org] 
     1= Jerbil -- Java build system based on Rake[http://rake.rubyforge.org] and RJB 
    22 
    3 This package contains several TaskLibs for rake which can be 
    4 used to build Java projects. 
     3  "If I knew then what I know now, I would have tried using a real 
     4  scripting language, such as JavaScript via the Rhino component or 
     5  Python via JPython, with bindings to Java objects which implemented 
     6  the functionality expressed in todays tasks. Then, there would be a 
     7  first class way to express logic and we wouldn't be stuck with XML as 
     8  a format that is too bulky for the way that people really want to use 
     9  the tool." 
     10   
     11    -- James Duncan Davidson, creator of ant 
     12  
     13This package contains several TaskLibs for Rake which can be 
     14used to build Java projects. Jerbil uses RJB[http://raa.ruby-lang.org/project/rjb/] 
     15(Ruby-Java-Bridge) to load a Java virtual machine in the ruby process running rake. 
     16 
     17The jvm is then used to compile Java source files, create javadocs etc. 
     18It is not a complete replacement for ant (yet), but has some significant advantages as it 
     19is easily scriptable. The main focus at the moment are small to medium-sized projects using  
     20testng[http://testng.org] and hibernate[http://hibernate.org]. 
     21 
     22== Requirements 
     23 
     24Jerbil requires rjb and JDK 1.5. The JAVA_HOME environment variable needs to point to the 
     25installed JDK. 
     26 
     27== Installation 
     28 
     29  % gem install jerbil --source http://code.trampolinesystems.com 
     30 
     31Jerbil might become an 'official' rubygem at some later point. Some tasks require additional 
     32jar files, for example Jerbil::TestNG::TestNGTask. 
     33 
     34The source code is available via anon svn: http://svn.trampolinesystems.com/jerbil/ 
     35   
     36== Example 
     37 
     38See the example/ subdirectory in the repository. 
     39 
     40  % svn co http://svn.trampolinesystems.com/jerbil/trunk/example 
     41 
     42== Advantages over ant 
     43 
     44Well, it's based on Ruby :) Additionally, RJB allows ruby classes to implement   
     45 
     46== FAQ 
     47 
     48See JerbilFAQ[http://code.trampolinesystems.com/jerbil/wiki/JerbilFAQ]. 
     49 
     50== License 
     51 
     52Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 
     53in compliance with the License. You may obtain a copy of the License at 
     54 
     55    http://www.apache.org/licenses/LICENSE-2.0 
     56 
     57Unless required by applicable law or agreed to in writing, software distributed under the License  
     58is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express  
     59or implied. See the License for the specific language governing permissions and limitations under  
     60the License.  

  • trunk/Rakefile

    r6042 r6047  
    55require 'rake/clean' 
    66 
     7CLEAN.include('pkg') 
    78WWWROOT   = "/var/www/code.trampolinesystems.com/" 
    89FILES     = FileList['lib/**/*', 'test/*.rb', 'classloader/*', 'COPYING', 'CHANGES', 'README'] 
    9 FULLFILES = FILES.clone.include('buildsupport/**/*', 'sample/**/*' ) 
     10FULLFILES = FILES.clone.include('buildsupport/**/*', 'example/**/*' ) 
    1011TESTFILES = FileList['test/test_java_helper.rb'] 
    11 FULLTESTFILES = TESTFILES.clone.include('test/test_java_helper.rb') 
    12 CLEAN.include('pkg') 
     12FULLTESTFILES = TESTFILES.clone.include('test/test_build.rb') 
     13 
    1314JERBIL_VERSION   = "0.1" 
    1415 
    …… 
    6061  rdoc.title    = "Jerbil" 
    6162  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README' 
    62   rdoc.rdoc_files.include("README", "CHANGES", "TODO", "lib/**/*.rb") 
     63  rdoc.rdoc_files.include("README", "CHANGES", "TODO", "LICENSE", "lib/**/*.rb") 
    6364end 
    6465   

  • trunk/example/sample.iml

    r5843 r6047  
    2323      <library> 
    2424        <CLASSES> 
    25           <root url="jar://$MODULE_DIR$/../buildsupport/testng-5.2-jdk15.jar!/" /> 
     25          <root url="jar://$MODULE_DIR$/../buildsupport/testng-5.3-jdk15.jar!/" /> 
    2626        </CLASSES> 
    2727        <JAVADOC />