summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreksperimental <eksperimental@users.noreply.github.com>2015-09-26 21:25:52 +0700
committereksperimental <eksperimental@users.noreply.github.com>2015-09-26 21:25:52 +0700
commit0f7da65f87599ebdc19c62add6e45e38520d8d9a (patch)
tree69772041541579cbd9dfc8e699c8211b0e5d489d
parent6a6ac511a157ae34422d9a2ae07c711150cfd640 (diff)
downloadelixir-0f7da65f87599ebdc19c62add6e45e38520d8d9a.tar.gz
Update README.md
* update license new license (EPL removed) * format lines to be 72 char long * update erlang requirements
-rw-r--r--README.md48
1 files changed, 34 insertions, 14 deletions
diff --git a/README.md b/README.md
index a9f5394ff..65b102258 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,15 @@
![Elixir](https://github.com/elixir-lang/elixir-lang.github.com/raw/master/images/logo/logo.png)
=========
-[![Build Status](https://secure.travis-ci.org/elixir-lang/elixir.svg?branch=master "Build Status")](https://travis-ci.org/elixir-lang/elixir)
+[![Build Status](https://secure.travis-ci.org/elixir-lang/elixir.svg?branch=master
+"Build Status")](https://travis-ci.org/elixir-lang/elixir)
-For more about Elixir, installation and documentation, [check Elixir's website](http://elixir-lang.org/).
+For more about Elixir, installation and documentation,
+[check Elixir's website](http://elixir-lang.org/).
## Usage
-If you want to contribute to Elixir or run it from source, clone this repository to your machine, compile and test it:
+If you want to contribute to Elixir or run it from source, clone this
+repository to your machine, compile and test it:
```sh
git clone https://github.com/elixir-lang/elixir.git
@@ -14,21 +17,34 @@ cd elixir
make clean test
```
-> Note: if you are running on Windows, [this article includes important notes for compiling Elixir from source on Windows](https://github.com/elixir-lang/elixir/wiki/Windows).
+> Note: if you are running on Windows,
+[this article includes important notes for compiling Elixir from source
+on Windows](https://github.com/elixir-lang/elixir/wiki/Windows).
-If Elixir fails to build (specifically when pulling in a new version via `git`), be sure to remove any previous build artifacts by running `make clean`, then `make test`.
+If Elixir fails to build (specifically when pulling in a new version via
+`git`), be sure to remove any previous build artifacts by running
+`make clean`, then `make test`.
-If tests pass, you are ready to move on to the [Getting Started guide][1] or to try Interactive Elixir by running: `bin/iex` in your terminal.
+If tests pass, you are ready to move on to the
+[Getting Started guide][1] or to try Interactive Elixir by running:
+`bin/iex` in your terminal.
-However, if tests fail, it is likely you have an outdated Erlang version (Elixir requires Erlang 17.0 or later). You can check your Erlang version by calling `erl` in the command line. You will see some information as follows:
+However, if tests fail, it is likely you have an outdated Erlang version
+(Elixir requires Erlang 18.0 or later).
+You can check your Erlang version by calling `erl` in the command line.
+You will see some information as follows:
-`Erlang/OTP 17 [erts-6.0] [source-07b8f44] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]`
+`Erlang/OTP 18 [erts-7.0] [source] [smp:2:2] [async-threads:10] [hipe]
+[kernel-poll:false]`
-If you have the correct version and tests still fail, feel free to [open an issue][2].
+If you have the correct version and tests still fail, feel free to
+[open an issue][2].
## Building documentation
-Building the documentation requires [ExDoc](https://github.com/elixir-lang/ex_doc) to be installed and built in the same containing folder as Elixir.
+Building the documentation requires
+[ExDoc](https://github.com/elixir-lang/ex_doc) to be installed and built
+in the same containing folder as Elixir.
```sh
# After cloning and compiling Elixir
@@ -39,7 +55,10 @@ cd ../elixir && make docs
## Contributing
-We appreciate any contribution to Elixir. Check our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and [CONTRIBUTING.md](CONTRIBUTING.md) guides for more information. We usually keep a list of features and bugs [in the issue tracker][2].
+We appreciate any contribution to Elixir.
+Check our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and
+[CONTRIBUTING.md](CONTRIBUTING.md) guides for more information.
+We usually keep a list of features and bugs [in the issue tracker][2].
## Important links
@@ -55,13 +74,14 @@ We appreciate any contribution to Elixir. Check our [CODE_OF_CONDUCT.md](CODE_OF
[3]: https://groups.google.com/group/elixir-lang-talk
[4]: https://groups.google.com/group/elixir-lang-core
[5]: irc://chat.freenode.net/elixir-lang
- [6]: http://www.freenode.net/
+ [6]: http://www.freenode.net
[7]: http://elixir-lang.org/docs.html
## License
"Elixir" and the Elixir logo are copyright (c) 2012 Plataformatec.
-Elixir source code is released under Apache 2 License with some parts under Erlang's license (EPL).
+Elixir source code is released under Apache 2 License.
-Check [NOTICE](NOTICE) and [LICENSE](LICENSE) files for more information.
+Check [NOTICE](NOTICE) and [LICENSE](LICENSE) files for more
+information.