-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
79 lines (40 loc) · 2.03 KB
/
README
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
===== icnelia =====
icnelia: is a word in nahuatl language that means "help"
Helper for compile, clean and create run scripts for your erlang OTP application
===== how to start =====
clone icnelia repository from github:
$ git clone https://github.com/jorgegarrido/icnelia.git
move into icnelia directory:
$ cd icnelia
build the project and script:
$ ./booticn
now you can use the icnelia script in your OTP applications:
===== how to use =====
just place the icnelia script into your main directory of your application
to compile:
$ ./icnelia compile
and it will compile all the code in src directory, also set the compiled files (.beam) under ebin directory
to clean:
$ ./icnelia clean
and it will clean all the compiled code in ebin directoy
to create a run script:
$ ./icnelia runner
and it will create a run script, to start your application (only start and load an erlang shell)
to create a run daemon script:
$ ./icnelia runner daemon
and it will create a run script, to start your application as daemon
===== icnelia.config =====
app_deps: here you can define the paths to ebin deps, for example:
{app_deps, [{"MY_DEP", "my_dep/ebin"}]}.
where "MY_DEP" is the name that the run script use to recongnize the path to your dep, and "my_dep/ebin" is the path to ebin for the dependence
all dependencies must be set on deps directory
pipes_dir: here you can define the path to your pipes directory, it is used when you want to run your application as daemon, for example:
{pipes_dir, "/usr/local/My_Pipes/"}.
NOTE: YOU MUST CREATE THE PIPES DIRECTORY MANUALLY
logs_dir: here you can define the path to logs used by your application, when it is running as daemon, for example:
{logs_dir, "/usr/local/My_Logs/"}.
NOTE: YOU MUST CREATE THE LOGS DIRECTORY MANUALLY
erl_opts: here you can set the options to compile the source code, the options are all supported by erlang version running, for example:
{erl_opts, [debug_info]}.
===== LICENSE =====
see LICENSE.txt for more info