Ryan Scheel (Havvy)
14ac3c5e97
Most of these docs are from the 1.0 Behaviour module docs, but those were seemingly lost at some point during the switch to @callback. I'm not sure whether it is better to put them on @behaviour or @callback, but I placed them on @behaviour. I'd rather see a "Behaviour" page that has this information, not just something randomly stuck in Module or Kernel.Typespec.
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-lang on Freenode IRC
License
"Elixir" and the Elixir logo are copyright (c) 2012 Plataformatec.
Elixir source code is released under Apache 2 License.