summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorViacheslav V. Kovalev <kovyl2404@gmail.com>2015-05-01 00:23:51 +0300
committerViacheslav V. Kovalev <kovyl2404@gmail.com>2015-05-01 00:23:51 +0300
commit33736f32a9a8bfd30711270e8f1376280915d697 (patch)
tree11924915352287650253a73ae7254af241c07625 /README.md
parent29a855d31c7fe7fd7504f5d0ec95c9a55e27276f (diff)
parent7645a1118f0e5cdc27e010905f5072021559ddfd (diff)
Merge branch 'master' into app-discover-profile-duplication
Conflicts: test/rebar_profiles_SUITE.erl
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 17 insertions, 7 deletions
diff --git a/README.md b/README.md
index 320b3cf..1fb3f57 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,8 @@ Example:
-behaviour(rebar_provider).
-export([init/1,
- do/1]).
+ do/1,
+ format_error/1]).
-define(PROVIDER, something).
-define(DEPS, []).
@@ -98,6 +99,10 @@ init(State) ->
do(State) ->
%% Do something
{ok, State}.
+
+-spec format_error(any()) -> iolist().
+format_error(Reason) ->
+ io_lib:format("~p", [Reason]).
```
@@ -118,16 +123,21 @@ You can download a pre-built binary version of rebar3 based on the last commit f
https://s3.amazonaws.com/rebar3/rebar3
-#### Building rebar
+#### Bootstrapping rebar3
```sh
$ git clone https://github.com/rebar/rebar3
$ cd rebar3
-$ ./bootstrap/bootstrap
-==> rebar (compile)
-Congratulations! You now have a self-contained script called "rebar3" in
-your current working directory. Place this script anywhere in your path
-and you can use rebar to build OTP-compliant apps.
+$ ./bootstrap
+```
+
+### Developing on rebar3
+
+When developing you can simply run `escriptize` to build your changes but the new escript is under `_build/default/bin/rebar3`
+
+```sh
+$ ./rebar3 escriptize
+$ _build/default/bin/rebar3
```