guilleiguaran / elixir

Elixir is a metaprogrammable, functional language built atop the Erlang VM. It is a dynamic language with hygenic macros that leverages Erlang's ability to build concurrent, distributed, and fault-tolerant applications with hot code upgrades.

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

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 R16B or later). You can check your Erlang version by calling erl in the command line. You will see some information as follows:

Erlang R16B (erts-5.10.1) [source] [64-bit] [smp:2:2] [rq:2] [async-threads:0] [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 ex_doc to be installed and built in the same containing folder as elixir.

# After cloning and compiling Elixir
$ git clone git://github.com/elixir-lang/ex_doc.git
$ cd ex_doc && ../elixir/bin/mix compile
$ cd ../elixir && make docs

Contributing

We appreciate any contribution to Elixir, so check out our CONTRIBUTING.md guide for more information. We usually keep a list of features and bugs in the issue tracker.

Important links

• #elixir-lang on freenode IRC
• Website
• 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 with some parts under Erlang's license (EPL).

Check LEGAL and LICENSE files for more information.