Current section

13 Versions

Jump to

Compare versions

6 files changed
+27 additions
-29 deletions
  @@ -5,18 +5,12 @@ rebar3_clojerl
5 5
6 6 Compile clojerl projects
7 7
8 - ## Build
9 -
10 - $ rebar3 compile
11 -
12 8 ## Use
13 9
14 - Add the plugin to your rebar config:
10 + Add the plugin to your `rebar.config` (along with `clojerl` as a dependency):
15 11
16 - { plugins
17 - , [ {rebar3_clojerl, ".*", {git, "https://github.com/clojerl/rebar3_clojerl", {tag, "0.6.5"}}}
18 - ]
19 - }.
12 + {deps, [clojerl]}.
13 + {plugins, [rebar3_clojerl]}.
20 14
21 15 Then just call the plugin directly in an existing application:
22 16
  @@ -69,16 +63,24 @@ also include the entry:
69 63 {clj_compile_first, ["foo/bar.clje"]}.
70 64 ```
71 65
66 + ## Plugin Development
67 +
68 + Run the following commands to checkout the repository and build the plugin:
69 +
70 + git checkout https://github.com/clojerl/rebar3_clojerl
71 + cd rebar3_clojerl
72 + rebar3 compile
73 +
72 74 ### Install globally
73 75
74 76 `rebar3` also allows you to install [plugins globally][rebar3-plugins] through its
75 77 configuration file `~/.config/rebar3/rebar.config`.
76 78
77 - By adding the following entry in the `plugins` section of the global `rebar.config`
78 - you will be able to use the plugin to build your project or create a new one through
79 - with the available [template](#template).
79 + By adding the following entry in the global `rebar.config` you will be able to use
80 + the plugin to build your project or create a new one with the available
81 + [template](#template).
80 82
81 - {rebar3_clojerl, ".*", {git, "https://github.com/clojerl/rebar3_clojerl", {tag, "0.6.6"}}}
83 + {plugins, [rebar3_clojerl]}.
82 84
83 85 ## Template
84 86
  @@ -89,10 +91,7 @@ to create a new Clojerl application.
89 91
90 92 ### Building the generated application
91 93
92 - There is a [provider_hook][rebar3-provider-hooks] in the generated application that
93 - will run `rebar3 clojerl compile` after running `rebar3 compile`. Therefore the current
94 - way of building a Clojerl application is by running `rebar3 compile` and **not**
95 - `rebar3 clojerl compile`.
94 + Running `rebar3 clojerl compile` will build the application.
96 95
97 96 ### Application name
  @@ -18,4 +18,4 @@
18 18 {<<"GitHub">>,<<"https://github.com/clojerl/rebar3_clojerl">>}]}.
19 19 {<<"name">>,<<"rebar3_clojerl">>}.
20 20 {<<"requirements">>,[]}.
21 - {<<"version">>,<<"0.6.7">>}.
21 + {<<"version">>,<<"0.6.8">>}.
  @@ -1,7 +1,7 @@
1 1 {description, "Complete structure for a Clojerl application."}.
2 2 {variables, [
3 3 {name, "mylib", "Name of the Clojerl application"},
4 - {desc, "A Clojerl application", "Short description of the app"}
4 + {description, "A Clojerl application", "Short description of the app"}
5 5 ]}.
6 6 {template, "core.clje.tpl", "{{name}}/src/{{name}}/core.clje"}.
7 7 {template, "app.clje.tpl", "{{name}}/src/{{name}}/app.clje"}.
  @@ -1,8 +1,4 @@
1 1 {erl_opts, [debug_info]}.
2 2
3 - {deps, [{clojerl, "0.5.0"}]}.
4 -
5 - { provider_hooks
6 - , [ {post, [{compile, {clojerl, compile}}]}
7 - ]
8 - }.
3 + {deps, [{clojerl, "0.5.1"}]}.
4 + {plugins, [{rebar3_clojerl, "0.6.8"}]}.
  @@ -1,6 +1,6 @@
1 1 {application,rebar3_clojerl,
2 2 [{description,"Compile clojerl projects"},
3 - {vsn,"0.6.7"},
3 + {vsn,"0.6.8"},
4 4 {registered,[]},
5 5 {applications,[kernel,stdlib]},
6 6 {env,[]},
Loading more files…