Installation: From sources

From sources

If you want to contribute then you might want to install Crystal from sources.

1. Install the latest Crystal release. To compile Crystal, you need Crystal :).

2. Make sure a supported LLVM version is present in the path. Currently, Crystal supports LLVM 3.8, 3.9 and 4.0. When possible, use the latest one. If you are using Mac and the Homebrew formula, this will be automatically configured for you if you install Crystal adding --with-llvm flag.

3. Make sure to install all the required libraries. You might also want to read the contributing guide.

4. Clone the repository:

git clone https://github.com/crystal-lang/crystal.git

1. Run make to build your own version of the compiler
2. Run make spec to ensure all specs pass, and you've installed everything correctly.
3. Use bin/crystal to run your crystal files

If you would like more information about the new bin/crystal, check out the using the compiler documentation.

Note: The actual binary is built in to .build/crystal, but the bin/crystal wrapper script is what you should use to run crystal.