Skip to content

Latest commit

 

History

History
190 lines (127 loc) · 6.29 KB

INSTALL.md

File metadata and controls

190 lines (127 loc) · 6.29 KB
Raw

Installing

Installing from source

The easiest way to install is via the existing generated Scheme code. The requirements are:

  • A Scheme compiler; either Chez Scheme (default), or Racket.
  • bash, GNU make, sha256sum and GMP. On Linux, you probably already have these. On macOS and major BSD flavours, you can install them using a package manager: for instance, on macOS, you can install with the brew install coreutils gmp and on OpenBSD, with the pkg_add coreutils bash gmake gmp command. You specifically need the dev GMP library, which means on some systems the package you need to install will be named something more like libgmp3-dev.

On Windows, it has been reported that installing via MSYS2 works MSYS2. On Windows older than Windows 8, you may need to set an environment variable OLD_WIN=1 or modify it in config.mk.

On Raspberry Pi, you can bootstrap via Racket.

By default, code generation is via Chez Scheme. You can use Racket instead, by setting the environment variable IDRIS2_CG=racket before running make. If you install Chez Scheme from source files, building it locally, make sure you run ./configure --threads to build multithreading support in.

NOTE: On FreeBSD, OpenBSD and NetBSD you need to use gmake command instead of make in the following steps.

NOTE: If you're running macOS on Apple Silicon (arm64) you may need to run "arch -x86_64 make ..." instead of make in the following steps.

1: Set installation target directory

  • Change the PREFIX in config.mk to the absolute path of your chosen installation destination. The default is to install in $HOME/.idris2

If you have an existing Idris 2, go to Step 3. Otherwise, read on...

Make sure that:

  • $PREFIX/bin is in your PATH
  • $PREFIX/lib is in your LD_LIBRARY_PATH or DYLD_LIBRARY_PATH if on macOS (so that the system knows where to look for library support code)

2: Installing without an existing Idris 2

You can build from pre-built Chez Scheme source, as long as you have Chez Scheme installed (or, alternatively, Racket). To do this, enter one of the following:

  • make bootstrap SCHEME=chez
  • make bootstrap-racket

chez is the executable name of the Chez Scheme compiler. You may need to replace this with the executable for Chez Scheme on your system. This could be scheme, chezscheme or chezscheme9.5 or something else, depending on your system and the Chez Scheme version.

This builds an Idris 2 compiler from scheme code output from a working Idris 2 compiler (which isn't necessarily up to date, but is up to date enough to build the current repository). It then rebuilds using the result, and runs the tests.

If all is well, to install, type:

  • make install

3: Installing with an existing Idris 2

If you have the latest released version of Idris 2 (0.4.0 at the time of writing) installed:

  • make all
  • make install

4: (Optional) Installing Idris 2 library documentation

After make install, type make install-libdocs to install Idris 2 library documentation. After that, the index file can be found here: idris2 --libdir`/docs/index.html`.

5: (Optional) Self-hosting step

As a final step, you can rebuild from the newly installed Idris 2 to verify that everything has worked correctly. Assuming that idris2 is in your PATH.

  • make clean -- to make sure you're building everything with the new version
  • make all && make install -- OR make all IDRIS2_BOOT='idris2 --codegen racket' && make install if using Racket.

6: Running tests

After make all, type make test to check everything works. This uses the executable in ./build/exec.

7: (Optional) Enabling incremental compilation

If you are working on Idris, incremental compilation means that rebuilds are much faster, at the cost of runtime performance being slower. To enable incremental compilation for the Chez back end, set the environment variable IDRIS2_INC_CGS=chez, or set the --inc chez flag in idris2.ipkg.

8: (Optional) Installing the Idris 2 API

You'll only need this if you're developing support tools, such as an external code generator. To do so, once everything is successfully installed, type:

  • make install-api

The API will only work if you've completed the self-hosting step (step 5), since the intermediate code versions need to be consistent throughout. Otherwise, you will get an Error in TTC: TTC data is in an older format error.

9: (Optional) Shell Auto-completion

Idris2 supports tab auto-completion for Bash-like shells.

For Bash Users

From within bash, run the following command:

eval "$(idris2 --bash-completion-script idris2)"

You can also add it to your .bashrc file.

For ZSH Users

From within ZSH, run the following commands:

autoload -U +X compinit && compinit
autoload -U +X bashcompinit && bashcompinit
eval "$(idris2 --bash-completion-script idris2)"

You can also add them to your .zshrc file.

Troubleshooting

If you get the message variable make-thread-parameter is not bound while bootstrapping via Chez Scheme, or while running the tests when bootstrapping via Racket, then your copy of Chez Scheme was built without thread support. Pass --threads to ./configure while building Chez Scheme to correct the issue.

Installing from a package manager

Installing using Homebrew

If you are Homebrew user you can install Idris 2 together with all the requirements by running the following command:

brew install idris2

Installing from nix

If you are a nix user you can install Idris 2 together with all the requirements by running the following command:

nix-env -i idris2

Install from nix flakes

If you are a nix flakes user you can install Idris 2 together with all the requirements by running the following command:

nix profile install github:idris-lang/Idris2

Running in text editor

Run on emacs using nix flakes

If you are a nix flakes user you can run Idris 2 in emacs by running the following command:

nix run github:idris-lang/Idris2#emacs-with-idris idrisCode.idr