diff options
author | Shea Levy <shea@shealevy.com> | 2015-11-27 13:34:38 -0500 |
---|---|---|
committer | Shea Levy <shea@shealevy.com> | 2015-11-27 13:34:38 -0500 |
commit | 9562549ff25033a8ef1ff3906079ec874bb5c67b (patch) | |
tree | 860dfc4abef544fc0ebb60e81ca6034183d976b3 /pkgs/development/idris-modules/README.md | |
parent | 0f90c9dbc1a42430883ab31853ba25e9d9ec26a5 (diff) | |
download | nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar.gz nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar.bz2 nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar.lz nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar.xz nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.tar.zst nixlib-9562549ff25033a8ef1ff3906079ec874bb5c67b.zip |
idris-modules: Add docs
Diffstat (limited to 'pkgs/development/idris-modules/README.md')
-rw-r--r-- | pkgs/development/idris-modules/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/pkgs/development/idris-modules/README.md b/pkgs/development/idris-modules/README.md new file mode 100644 index 000000000000..005ed3602851 --- /dev/null +++ b/pkgs/development/idris-modules/README.md @@ -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`. \ No newline at end of file |