浏览代码

Update README: fix formatting

pull/3/head
Tuncer Ayaz 14 年前
父节点
当前提交
0cb006aa66
共有 1 个文件被更改,包括 20 次插入17 次删除
  1. +20
    -17
      README.md

+ 20
- 17
README.md 查看文件

@ -32,15 +32,17 @@ Clone the git repository:
#### Building rebar #### Building rebar
$ cd rebar/
$ ./bootstrap
Recompile: src/getopt
...
Recompile: src/rebar_utils
==> rebar (compile)
Congratulations! You now have a self-contained script called "rebar" in
your current working directory. Place this script anywhere in your path
and you can use rebar to build OTP-compliant apps.
```sh
$ cd rebar
$ ./bootstrap
Recompile: src/getopt
...
Recompile: src/rebar_utils
==> rebar (compile)
Congratulations! You now have a self-contained script called "rebar" in
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
> Add 'foobar' command
> Change default timeout to 123
* `Fix bug 123`
* `Add 'foobar' command`
* `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>
$ cd rebar/
```sh
$ 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).

正在加载...
取消
保存