summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2012-06-08 23:13:33 +0200
committerLudovic Courtès <ludo@gnu.org>2012-06-08 23:13:33 +0200
commit4255d4e3c5c17b3f170f287388710ca1dc5cb711 (patch)
treea173b01581f01556d2d13f431ebfe509caea7534 /README
parentd9085c23c4503347366e54707e80025ca4526941 (diff)
Augment `README'.
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 37 insertions, 0 deletions
diff --git a/README b/README
index b77c0fa4c9c..442e4c3f355 100644
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
1-*- mode: org -*-
2
1Guix is Nix[0] from Guile[1]! 3Guix is Nix[0] from Guile[1]!
2 4
3Concretely, it allows Nix package management to be done entirely in 5Concretely, it allows Nix package management to be done entirely in
@@ -7,3 +9,38 @@ Nix language.
7 9
8[0] http://nixos.org/nix/ 10[0] http://nixos.org/nix/
9[1] http://gnu.org/software/guile/ 11[1] http://gnu.org/software/guile/
12
13
14* Hacking
15
16Guix currently depends on the following packages:
17
18 - GNU Guile 2.0.x, http://gnu.org/software/guile/
19 - Nix, http://nixos.org/nix/
20 - libchop, http://nongnu.org/libchop/
21
22For bootstrapping purposes, it is useful to reuse packages from Nixpkgs.
23For this to work, you need to have a checkout of the Nixpkgs repository,
24with the `NIXPKGS' environment variable pointing to it.
25
26 - Nixpkgs, http://nixos.org/nixpkgs/
27
28* How It Works
29
30Guix does the high-level preparation of a /derivation/. A derivation is
31the promise of a build; it is stored as a text file under
32=/nix/store/xxx.drv=. The (guix derivations) module provides the
33`derivation' primitive, as well as higher-level wrappers such as
34`build-expression->derivation'.
35
36Guix does remote procedure calls (RPCs) to the Nix daemon (the
37=nix-worker --daemon= command), which in turn performs builds and
38accesses to the Nix store on its behalf. The RPCs are implemented in
39the (guix store) module.
40
41* Contact
42
43The repository is at <https://gitorious.org/guix/>.
44
45Please email <ludo@gnu.org> or <nix-dev@lists.science.uu.nl>, or
46join #guile or #nixos on irc.freenode.net or `civodul'.