From acf8c5ce65718fbaaae666baf312890f3e8857af Mon Sep 17 00:00:00 2001 From: Tristan Sloughter Date: Wed, 22 Apr 2015 22:00:40 -0500 Subject: update readme bootstrap instructions --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 320b3cf..555cddf 100644 --- a/README.md +++ b/README.md @@ -123,11 +123,7 @@ https://s3.amazonaws.com/rebar3/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 ``` -- cgit v1.1 From 390d1afb77fe58c0f083b46ad114a37d1ad1d91d Mon Sep 17 00:00:00 2001 From: Tristan Sloughter Date: Wed, 22 Apr 2015 22:01:13 -0500 Subject: update readme provider --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 555cddf..bc2accd 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]). ``` -- cgit v1.1 From 7b723d3a87230a893e61130024b5dbc38a3a749c Mon Sep 17 00:00:00 2001 From: Tristan Sloughter Date: Wed, 22 Apr 2015 22:03:45 -0500 Subject: update readme instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index bc2accd..1fb3f57 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ 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 @@ -131,6 +131,15 @@ $ cd rebar3 $ ./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 +``` + Contributing to rebar ===================== -- cgit v1.1