forked from mirrors/nixpkgs
idris-modules: Add docs
This commit is contained in:
parent
0f90c9dbc1
commit
9562549ff2
39
pkgs/development/idris-modules/README.md
Normal file
39
pkgs/development/idris-modules/README.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
Idris packages
|
||||
==============
|
||||
|
||||
This directory contains build rules for idris packages. In addition,
|
||||
it contains several functions to build and compose those packages.
|
||||
Everything is exposed to the user via the `idrisPackages` attribute.
|
||||
|
||||
callPackage
|
||||
------------
|
||||
|
||||
This is like the normal nixpkgs callPackage function, specialized to
|
||||
idris packages.
|
||||
|
||||
builtins
|
||||
---------
|
||||
|
||||
This is a list of all of the libraries that come packaged with Idris
|
||||
itself.
|
||||
|
||||
build-idris-package
|
||||
--------------------
|
||||
|
||||
A function to build an idris package. Its sole argument is a set like
|
||||
you might pass to `stdenv.mkDerivation`, except `build-idris-package`
|
||||
sets several attributes for you. See `build-idris-package.nix` for
|
||||
details.
|
||||
|
||||
build-builtin-package
|
||||
----------------------
|
||||
|
||||
A version of `build-idris-package` specialized to builtin libraries.
|
||||
Mostly for internal use.
|
||||
|
||||
with-packages
|
||||
-------------
|
||||
|
||||
Bundle idris together with a list of packages. Because idris currently
|
||||
only supports a single directory in its library path, you must include
|
||||
all desired libraries here, including `prelude` and `base`.
|
3
pkgs/development/idris-modules/TODO.md
Normal file
3
pkgs/development/idris-modules/TODO.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
* Build the RTS separately from Idris
|
||||
* idris2nix
|
||||
* Only require gmp, rts when compiling executables
|
Loading…
Reference in a new issue