For more about Elixir, installation and documentation, check Elixir's website.

Usage

If you want to contribute to Elixir or run it from source, clone this repository to your machine, compile and test it:

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.

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 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.

Building documentation

Building the documentation requires ExDoc to be installed and built alongside Elixir.

# 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 and CONTRIBUTING.md guides for more information. We usually keep a list of features and bugs in the issue tracker.

Important links

• Elixir Website
• Elixir Documentation
• #elixir-lang on Freenode IRC
• Issue tracker
• elixir-talk Mailing list (questions)
• elixir-core Mailing list (development)

License

"Elixir" and the Elixir logo are copyright (c) 2012 Plataformatec.

Elixir source code is released under Apache 2 License.

Check NOTICE and LICENSE files for more information.