Tejas Manohar
1932b5243e
most IRC clients don't seem to support irc://, obviously not the command-line ones. additionally, GitHub doesn't consider irc:// a hyperlink so that's less useful but it does hyperlink this (and we're on freenode) update webchat URL to have the correct channel
90 lines
2.9 KiB
Markdown
90 lines
2.9 KiB
Markdown
|
|
=========
|
|
[](https://travis-ci.org/elixir-lang/elixir)
|
|
|
|
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:
|
|
|
|
```sh
|
|
git clone https://github.com/elixir-lang/elixir.git
|
|
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).
|
|
|
|
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.
|
|
|
|
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 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].
|
|
|
|
## Building documentation
|
|
|
|
Building the documentation requires
|
|
[ExDoc](https://github.com/elixir-lang/ex_doc) to be installed and built
|
|
alongside Elixir.
|
|
|
|
```sh
|
|
# After cloning and compiling Elixir, in its parent directory:
|
|
git clone git://github.com/elixir-lang/ex_doc.git
|
|
cd ex_doc && ../elixir/bin/mix do deps.get, compile
|
|
cd ../elixir && make docs
|
|
```
|
|
|
|
This will produce documentation sets for `elixir`, `mix`, etc., under the `doc` directory.
|
|
|
|
## 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].
|
|
|
|
## Important links
|
|
|
|
* [Elixir Website][1]
|
|
* [Elixir Documentation][7]
|
|
* **[#elixir-lang][5]** on [Freenode][6] IRC
|
|
* [Issue tracker][2]
|
|
* [elixir-talk Mailing list (questions)][3]
|
|
* [elixir-core Mailing list (development)][4]
|
|
|
|
[1]: http://elixir-lang.org
|
|
[2]: https://github.com/elixir-lang/elixir/issues
|
|
[3]: https://groups.google.com/group/elixir-lang-talk
|
|
[4]: https://groups.google.com/group/elixir-lang-core
|
|
[5]: https://webchat.freenode.net/?channels=#elixir-lang
|
|
[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.
|
|
|
|
Check [NOTICE](NOTICE) and [LICENSE](LICENSE) files for more
|
|
information.
|