SisMaker
/
rebar3
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 62 Wiki Activity
Browse Source

Merge pull request #2018 from jsoref/patch-1 

switch documentation links to https where supported
pull/2024/head
Fred Hebert 6 years ago
committed by GitHub
parent
07f5e3d2d2 440888dd40
commit
80c8417024
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 22 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +22
    -22
      README.md

+ 22
- 22
README.md View File

@ -19,18 +19,18 @@ release Erlang libraries, applications, and systems in a repeatable manner.
Rebar3 will: Rebar3 will:
- respect and enforce standard Erlang/OTP conventions for project - respect and enforce standard Erlang/OTP conventions for project
structure so they are easily reusable by the community; structure so they are easily reusable by the community;
- manage source dependencies and Erlang [packages](http://hex.pm)
- manage source dependencies and Erlang [packages](https://hex.pm)
while ensuring repeatable builds; while ensuring repeatable builds;
- handle build artifacts, paths, and libraries such that standard - handle build artifacts, paths, and libraries such that standard
development tools can be used without a headache; development tools can be used without a headache;
- adapt to projects of all sizes on almost any platform; - adapt to projects of all sizes on almost any platform;
- treat [documentation](http://www.rebar3.org/docs/) as a feature,
- treat [documentation](https://www.rebar3.org/docs/) as a feature,
and errors or lack of documentation as a bug. and errors or lack of documentation as a bug.
Rebar3 is also a self-contained Erlang script. It is easy to distribute or Rebar3 is also a self-contained Erlang script. It is easy to distribute or
embed directly in a project. Tasks or behaviours can be modified or expanded embed directly in a project. Tasks or behaviours can be modified or expanded
with a [plugin system](http://www.rebar3.org/docs/using-available-plugins)
[flexible enough](http://www.rebar3.org/docs/plugins) that even other languages
with a [plugin system](https://www.rebar3.org/docs/using-available-plugins)
[flexible enough](https://www.rebar3.org/docs/plugins) that even other languages
on the Erlang VM will use it as a build tool. on the Erlang VM will use it as a build tool.
## Why Rebar3 ## Why Rebar3
@ -53,7 +53,7 @@ best experience you can get.
## Getting Started ## Getting Started
A [getting started guide is maintained on the official documentation website](http://www.rebar3.org/docs/getting-started),
A [getting started guide is maintained on the official documentation website](https://www.rebar3.org/docs/getting-started),
but installing rebar3 can be done by any of the ways described below but installing rebar3 can be done by any of the ways described below
Latest stable compiled version: Latest stable compiled version:
@ -88,7 +88,7 @@ Rebar3 may also be available on various OS-specific package managers such as
FreeBSD Ports. Those are maintained by the community and Rebar3 maintainers FreeBSD Ports. Those are maintained by the community and Rebar3 maintainers
themselves are generally not involved in that process. themselves are generally not involved in that process.
If you do not have a full Erlang install, we using [erln8](http://erln8.github.io/erln8/)
If you do not have a full Erlang install, we using [erln8](https://erln8.github.io/erln8/)
or [kerl](https://github.com/yrashk/kerl). For binary packages use those provided or [kerl](https://github.com/yrashk/kerl). For binary packages use those provided
by [Erlang Solutions](https://www.erlang-solutions.com/resources/download.html), by [Erlang Solutions](https://www.erlang-solutions.com/resources/download.html),
but be sure to choose the "Standard" download option or you'll have issues building but be sure to choose the "Standard" download option or you'll have issues building
@ -96,7 +96,7 @@ projects.
## Documentation ## Documentation
Rebar3 documentation is maintained on [http://www.rebar3.org/docs](http://www.rebar3.org/docs)
Rebar3 documentation is maintained on [https://www.rebar3.org/docs](https://www.rebar3.org/docs)
## Features ## Features
@ -112,21 +112,21 @@ others via the plugin ecosystem:
| Clean up artifacts | Remove the compiled beam files from a project with `rebar3 clean` or just remove the `_build` directory to remove *all* compilation artifacts | | Clean up artifacts | Remove the compiled beam files from a project with `rebar3 clean` or just remove the `_build` directory to remove *all* compilation artifacts |
| Code Coverage | Various commands can be instrumented to accumulate code coverage data (such as `eunit` or `ct`). Reports can be generated with `rebar3 cover` | | Code Coverage | Various commands can be instrumented to accumulate code coverage data (such as `eunit` or `ct`). Reports can be generated with `rebar3 cover` |
| Common Test | The test framework can be run by calling `rebar3 ct` | | Common Test | The test framework can be run by calling `rebar3 ct` |
| Dependencies | Rebar3 maintains local copies of dependencies on a per-project basis. They are fetched deterministically, can be locked, upgraded, fetched from source, packages, or from local directories. See [Dependencies on the documentation website](http://www.rebar3.org/docs/dependencies). Call `rebar3 tree` to show the whole dependency tree. |
| Documentation | Print help for rebar3 itself (`rebar3 help`) or for a specific task (`rebar3 help <task>`). Full reference at [www.rebar3.org](http://www.rebar3.org/docs). |
| Dependencies | Rebar3 maintains local copies of dependencies on a per-project basis. They are fetched deterministically, can be locked, upgraded, fetched from source, packages, or from local directories. See [Dependencies on the documentation website](https://www.rebar3.org/docs/dependencies). Call `rebar3 tree` to show the whole dependency tree. |
| Documentation | Print help for rebar3 itself (`rebar3 help`) or for a specific task (`rebar3 help <task>`). Full reference at [www.rebar3.org](https://www.rebar3.org/docs). |
| Dialyzer | Run the Dialyzer analyzer on the project with `rebar3 dialyzer`. Base PLTs for each version of the language will be cached and reused for faster analysis | | Dialyzer | Run the Dialyzer analyzer on the project with `rebar3 dialyzer`. Base PLTs for each version of the language will be cached and reused for faster analysis |
| Edoc | Generate documentation using edoc with `rebar3 edoc` | | Edoc | Generate documentation using edoc with `rebar3 edoc` |
| Escript generation | Rebar3 can be used to generate [escripts](http://www.erlang.org/doc/man/escript.html) providing an easy way to run all your applications on a system where Erlang is installed | | Escript generation | Rebar3 can be used to generate [escripts](http://www.erlang.org/doc/man/escript.html) providing an easy way to run all your applications on a system where Erlang is installed |
| Eunit | The test framework can be run by calling `rebar3 eunit` | | Eunit | The test framework can be run by calling `rebar3 eunit` |
| Locked dependencies | Dependencies are going to be automatically locked to ensure repeatable builds. Versions can be changed with `rebar3 upgrade` or `rebar3 upgrade <app>`, or locks can be released altogether with `rebar3 unlock`. | | Locked dependencies | Dependencies are going to be automatically locked to ensure repeatable builds. Versions can be changed with `rebar3 upgrade` or `rebar3 upgrade <app>`, or locks can be released altogether with `rebar3 unlock`. |
| Packages | [Hex packages](http://hex.pm) can be listed with `rebar3 pkgs`. They can be used as dependencies, will be cached locally for faster usage, and a local index will be used and updated with `rebar3 update`. |
| Packages | [Hex packages](https://hex.pm) can be listed with `rebar3 pkgs`. They can be used as dependencies, will be cached locally for faster usage, and a local index will be used and updated with `rebar3 update`. |
| Path | While paths are managed automatically, you can print paths to the current build directories with `rebar3 path`. | | Path | While paths are managed automatically, you can print paths to the current build directories with `rebar3 path`. |
| Plugins | Rebar3 can be fully extended with [plugins](#http://www.rebar3.org/docs/using-available-plugins). List or upgrade plugins by using the plugin namespace (`rebar3 plugins`). |
| Profiles | Rebar3 can have subconfiguration options for different profiles, such as `test` or `prod`. These allow specific dependencies or compile options to be used in specific contexts. See [Profiles](http://www.rebar3.org/docs/profiles) in the docs. |
| Releases | Rebar3 supports [building releases](http://www.rebar3.org/docs/releases) with the `relx` tool, providing a way to ship fully self-contained Erlang systems. Release update scripts for live code updates can also be generated. |
| Plugins | Rebar3 can be fully extended with [plugins](https://www.rebar3.org/docs/using-available-plugins). List or upgrade plugins by using the plugin namespace (`rebar3 plugins`). |
| Profiles | Rebar3 can have subconfiguration options for different profiles, such as `test` or `prod`. These allow specific dependencies or compile options to be used in specific contexts. See [Profiles](https://www.rebar3.org/docs/profiles) in the docs. |
| Releases | Rebar3 supports [building releases](https://www.rebar3.org/docs/releases) with the `relx` tool, providing a way to ship fully self-contained Erlang systems. Release update scripts for live code updates can also be generated. |
| Shell | A full shell with your applications available can be started with `rebar3 shell`. From there, call tasks as `r3:do(compile)` to automatically recompile and reload the code without interruption | | Shell | A full shell with your applications available can be started with `rebar3 shell`. From there, call tasks as `r3:do(compile)` to automatically recompile and reload the code without interruption |
| Tarballs | Releases can be packaged into tarballs ready to be deployed. | | Tarballs | Releases can be packaged into tarballs ready to be deployed. |
| Templates | Configurable templates ship out of the box (try `rebar3 new` for a list or `rebar3 new help <template>` for a specific one). [Custom templates](http://www.rebar3.org/docs/using-templates) are also supported, and plugins can also add their own. |
| Templates | Configurable templates ship out of the box (try `rebar3 new` for a list or `rebar3 new help <template>` for a specific one). [Custom templates](https://www.rebar3.org/docs/using-templates) are also supported, and plugins can also add their own. |
| Unstable namespace | We use a namespace to provide commands that are still in flux, allowing to test more experimental features we are working on. See `rebar3 unstable`. | | Unstable namespace | We use a namespace to provide commands that are still in flux, allowing to test more experimental features we are working on. See `rebar3 unstable`. |
| Xref | Run cross-reference analysis on the project with [xref](http://www.erlang.org/doc/apps/tools/xref_chapter.html) by calling `rebar3 xref`. | | Xref | Run cross-reference analysis on the project with [xref](http://www.erlang.org/doc/apps/tools/xref_chapter.html) by calling `rebar3 xref`. |
@ -135,13 +135,13 @@ others via the plugin ecosystem:
The grievances we had with Rebar 2.x were not fixable without breaking The grievances we had with Rebar 2.x were not fixable without breaking
compatibility in some very important ways. compatibility in some very important ways.
A full guide titled [From Rebar 2.x to Rebar3](http://www.rebar3.org/docs/from-rebar-2x-to-rebar3)
A full guide titled [From Rebar 2.x to Rebar3](https://www.rebar3.org/docs/from-rebar-2x-to-rebar3)
is provided on the documentation website. is provided on the documentation website.
Notable modifications include mandating a more standard set of directory Notable modifications include mandating a more standard set of directory
structures, changing the handling of dependencies, moving some compilers (such structures, changing the handling of dependencies, moving some compilers (such
as C, Diameter, ErlyDTL, or ProtoBuffs) to as C, Diameter, ErlyDTL, or ProtoBuffs) to
[plugins](http://www.rebar3.org/docs/using-available-plugins) rather than
[plugins](https://www.rebar3.org/docs/using-available-plugins) rather than
maintaining them in core rebar, and moving release builds from reltool to maintaining them in core rebar, and moving release builds from reltool to
relx. relx.
@ -153,10 +153,10 @@ also where you want to go for questions about how to extend rebar, fill in bug
reports, and so on. reports, and so on.
The main place to go for questions is the [rebar mailing The main place to go for questions is the [rebar mailing
list](http://lists.basho.com/pipermail/rebar_lists.basho.com/). If you need
list](https://lists.basho.com/pipermail/rebar_lists.basho.com/). If you need
quick feedback, you can try the #rebar channel on quick feedback, you can try the #rebar channel on
[irc.freenode.net](http://freenode.net). Be sure to check the
[documentation](http://www.rebar3.org/v3.0/docs) first, just to be sure you're not
[irc.freenode.net](https://freenode.net). Be sure to check the
[documentation](https://www.rebar3.org/v3.0/docs) first, just to be sure you're not
asking about things with well-known answers. asking about things with well-known answers.
For bug reports, roadmaps, and issues, visit the [github issues For bug reports, roadmaps, and issues, visit the [github issues
@ -164,10 +164,10 @@ page](https://github.com/erlang/rebar3/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 on [irc.freenode.net](http://freenode.net/)
- [Rebar Mailing List](https://lists.basho.com/pipermail/rebar_lists.basho.com/)
- #rebar on [irc.freenode.net](https://freenode.net/)
- [issues](https://github.com/erlang/rebar3/issues) - [issues](https://github.com/erlang/rebar3/issues)
- [Documentation](http://www.rebar3.org/v3.0/docs)
- [Documentation](https://www.rebar3.org/v3.0/docs)
To contribute to rebar3, please refer to [CONTRIBUTING](CONTRIBUTING.md). To contribute to rebar3, please refer to [CONTRIBUTING](CONTRIBUTING.md).

Write Preview
Loading…
Cancel
Save