charpi / erl_rake

Some rake tasks to build an erlang project

This URL has Read+Write access

charpi (author)
Sat Jun 13 00:06:09 -0700 2009
commit  2660849171989eb4a41b6c4f64bddafecd1958ba
tree    e23793ae4da66c198d2666b9eef808a75c8510dc
parent  25c7fe4df5d31fedcf327bf627975dc0d435218a
erl_rake / README
100644 30 lines (23 sloc) 1.406 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Sample erlang application to demonstrate the use of rake tasks dedicated to erlang.
 
= Installation =
 
Put in your project the directory 'rakelib' it contains all '.rake'
files and some escript needed by tasks.
 
= Usage =
rake --tasks : to know all tasks
 
You'll need a configuration in which you'll have to put things specific to your installation.
A template of file is generated the first time you launch 'rake'
 
Here is some useful tasks:
rake erlang:modules: Compile all erlang source files (test included)
rake erlang:releases: Build a tarball for each rel file found in the directory tree
rake erlang:tests[name]: Run the eunit test for the application "name". If no name is given,
     all applications are tested. If a file test.desc is find in the "app_name/test" directory, eunit will
     use it as eunit test description.
rake erlang:edoc[name]: Build the document for an application or all if 'name' is omitted
rake otp:new_application[name]: Create a new application squeleton
rake otp:start_local[name]: Start a release in the developper environment
 
rake otp:initial_targer[name,version]: Create a tarball with a 'ready' to deploy
     an erlang system running the release. To use the system, you have to provide
     2 startup files in a directory named 'release_config'. Look at the sample in the
     application sample_rake.
= Author =
Nicolas Charpentier <open_source@charpi.net>