github/rebar
1
0
Fork 0
mirror of https://github.com/correl/rebar.git synced 2024-11-23 19:19:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README: fix formatting

Browse source
This commit is contained in:
Tuncer Ayaz 2011-05-21 12:52:53 +02:00
parent e6730e464e
commit 0cb006aa66
1 changed files with 20 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -32,15 +32,17 @@ Clone the git repository:
#### Building rebar #### Building rebar
$ cd rebar/ ```sh
$ ./bootstrap $ cd rebar
Recompile: src/getopt $ ./bootstrap
... Recompile: src/getopt
Recompile: src/rebar_utils ...
==> rebar (compile) Recompile: src/rebar_utils
Congratulations! You now have a self-contained script called "rebar" in ==> rebar (compile)
your current working directory. Place this script anywhere in your path Congratulations! You now have a self-contained script called "rebar" in
and you can use rebar to build OTP-compliant apps. your current working directory. Place this script anywhere in your path
and you can use rebar to build OTP-compliant apps.
```
Contributing to rebar Contributing to rebar
@ -85,9 +87,9 @@ Longer description (wrap at 72 characters)
* Less than 50 characters * Less than 50 characters
* What was changed * What was changed
* Imperative present tense (fix, add, change) * Imperative present tense (fix, add, change)
> Fix bug 123 * `Fix bug 123`
> Add 'foobar' command * `Add 'foobar' command`
> Change default timeout to 123 * `Change default timeout to 123`
* No period * No period
### Description ### Description
@ -107,17 +109,18 @@ Dialyzer and Tidier
Before you submit a patch check for discrepancies with Before you submit a patch check for discrepancies with
[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html): [Dialyzer](http://www.erlang.org/doc/man/dialyzer.html):
<pre> ```sh
$ cd rebar/ $ cd rebar
$ ./bootstrap debug $ ./bootstrap debug
$ dialyzer ebin -Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspecs $ dialyzer ebin -Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspecs
</pre> ```
The following discrepancies are known and safe to ignore: The following discrepancies are known and safe to ignore:
<pre>
```
rebar_utils.erl:147: Call to missing or unexported function escript:foldl/3 rebar_utils.erl:147: Call to missing or unexported function escript:foldl/3
rebar_utils.erl:180: The created fun has no local return rebar_utils.erl:180: The created fun has no local return
</pre> ```
It is **strongly recommended** to check the code with It is **strongly recommended** to check the code with
[Tidier](http://tidier.softlab.ntua.gr:20000/tidier/getstarted). [Tidier](http://tidier.softlab.ntua.gr:20000/tidier/getstarted).