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

Various updates for README to reflect new home for rebar

Browse source
This commit is contained in:
Dave Smith 2012-10-30 21:51:46 -06:00
parent 3ee3a7cd9e
commit 3a78ef8aa9
1 changed files with 40 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
README.md
View file

@ -1,29 +1,28 @@
rebar rebar
===== =====
rebar is an Erlang build tool that makes it easy to compile and rebar is an Erlang build tool that makes it easy to compile and test Erlang
test Erlang applications, port drivers and releases. applications, port drivers and releases.
[![Build Status](https://secure.travis-ci.org/basho/rebar.png?branch=master)](http://travis-ci.org/basho/rebar) [![Build Status](https://secure.travis-ci.org/basho/rebar.png?branch=master)](http://travis-ci.org/basho/rebar)
rebar is a self-contained Erlang script, so it's easy to distribute or even rebar is a self-contained Erlang script, so it's easy to distribute or even
embed directly in a project. Where possible, rebar uses standard Erlang/OTP embed directly in a project. Where possible, rebar uses standard Erlang/OTP
conventions for project structures, thus minimizing the amount of build conventions for project structures, thus minimizing the amount of build
configuration work. rebar also provides dependency management, enabling configuration work. rebar also provides dependency management, enabling
application writers to easily re-use common libraries from a variety of application writers to easily re-use common libraries from a variety of
locations (git, hg, etc). locations (git, hg, etc).
Building Building
-------- --------
Information on building and installing [Erlang/OTP](http://www.erlang.org) Information on building and installing [Erlang/OTP](http://www.erlang.org) can
can be found [here](https://github.com/erlang/otp/wiki/Installation) be found [here](https://github.com/erlang/otp/wiki/Installation) ([more
([more info](https://github.com/erlang/otp/blob/master/INSTALL.md)). info](https://github.com/erlang/otp/blob/master/INSTALL.md)).
### Dependencies ### Dependencies
To build rebar you will need a working installation of Erlang R13B03 (or To build rebar you will need a working installation of Erlang R13B03 (or later).
later).
Should you want to clone the rebar repository, you will also require git. Should you want to clone the rebar repository, you will also require git.
@ -31,12 +30,12 @@ Should you want to clone the rebar repository, you will also require git.
You can download a pre-built binary version of rebar from: You can download a pre-built binary version of rebar from:
https://github.com/basho/rebar/wiki/rebar https://github.com/rebar/rebar/wiki/rebar
#### Building rebar #### Building rebar
```sh ```sh
$ git clone git://github.com/basho/rebar.git $ git clone git://github.com/rebar/rebar.git
$ cd rebar $ cd rebar
$ ./bootstrap $ ./bootstrap
Recompile: src/getopt Recompile: src/getopt
@ -72,9 +71,10 @@ Do not mix spaces and tabs.
Do not introduce lines longer than 80 characters. Do not introduce lines longer than 80 characters.
[erlang-mode (emacs)](http://www.erlang.org/doc/man/erlang.el.html) indentation is preferred. [erlang-mode (emacs)](http://www.erlang.org/doc/man/erlang.el.html) indentation
vi-only users are encouraged to is preferred. vi-only users are encouraged to give [Vim
give [Vim emulation](http://emacswiki.org/emacs/Evil) ([more info](https://gitorious.org/evil/pages/Home)) a try. emulation](http://emacswiki.org/emacs/Evil) ([more
info](https://gitorious.org/evil/pages/Home)) a try.
Writing Commit Messages Writing Commit Messages
----------------------- -----------------------
@ -111,43 +111,39 @@ Longer description (wrap at 72 characters)
Run checks Run checks
---------- ----------
Before you submit a patch, run ``make check`` to execute Before you submit a patch, run ``make check`` to execute the test suite and
the test suite and check for check for [xref](http://www.erlang.org/doc/man/xref.html) and
[xref](http://www.erlang.org/doc/man/xref.html) and [Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings. You may have
[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) to run ``make clean`` first.
warnings. You may have to run ``make clean`` first.
[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings are compared [Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings are compared
against a set of safe-to-ignore warnings found in against a set of safe-to-ignore warnings found in
[dialyzer_reference](https://raw.github.com/basho/rebar/master/dialyzer_reference). [dialyzer_reference](https://raw.github.com/rebar/rebar/master/dialyzer_reference).
[xref](http://www.erlang.org/doc/man/xref.html) is run with [xref](http://www.erlang.org/doc/man/xref.html) is run with [custom
[custom queries](https://raw.github.com/basho/rebar/master/rebar.config) queries](https://raw.github.com/rebar/rebar/master/rebar.config) to suppress
to suppress safe-to-ignore warnings. safe-to-ignore warnings.
It is **strongly recommended** to check the code with
[Tidier](http://tidier.softlab.ntua.gr:20000/tidier/getstarted).
Select all transformation
options and enable **automatic** transformation. If Tidier suggests a transformation,
apply the changes **manually** to the source code. Do not use the code from
the
tarball (*out.tgz*) as it will have white-space changes applied by Erlang's pretty-printer.
Community and Resources Community and Resources
----------------------- -----------------------
In case of problems that cannot be solved through documentation or examples, you may In case of problems that cannot be solved through documentation or examples, you
want to try to contact members of the community for help. The community is also where may want to try to contact members of the community for help. The community is
you want to go for questions about how to extend rebar, fill in bug reports, and so on. also where you want to go for questions about how to extend rebar, fill in bug
reports, and so on.
The main place to go for questions is the [rebar mailing list](http://lists.basho.com/pipermail/rebar_lists.basho.com/). If you need quick feedback, The main place to go for questions is the [rebar mailing
you can try the #rebar channel on [irc.freenode.net](http://freenode.net). Be sure to check the [wiki](https://github.com/basho/rebar/wiki) first, list](http://lists.basho.com/pipermail/rebar_lists.basho.com/). If you need
just to be sure you're not asking about things with well known answers. quick feedback, you can try the #rebar channel on
[irc.freenode.net](http://freenode.net). Be sure to check the
[wiki](https://github.com/rebar/rebar/wiki) first, just to be sure you're not
asking about things with well known answers.
For bug reports, roadmaps, and issues, visit the [github issues page](https://github.com/basho/rebar/issues). For bug reports, roadmaps, and issues, visit the [github issues
page](https://github.com/rebar/rebar/issues).
General rebar community resources and links: General rebar community resources and links:
- [Rebar Mailing List](http://lists.basho.com/pipermail/rebar_lists.basho.com/) - [Rebar Mailing List](http://lists.basho.com/pipermail/rebar_lists.basho.com/)
- #rebar on [irc.freenode.net](http://freenode.net/) - #rebar on [irc.freenode.net](http://freenode.net/)
- [wiki](https://github.com/basho/rebar/wiki) - [wiki](https://github.com/rebar/rebar/wiki)
- [issues](https://github.com/basho/rebar/issues) - [issues](https://github.com/rebar/rebar/issues)