You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Ludovic Courtès 09c95deb1e Change email address in `AUTHORS'. 9 years ago
build-aux distro: Rebuild bootstrap Binutils and GCC. 9 years ago
distro/packages distro: Add ACL. 9 years ago
doc doc: Mention the pronunciation of "Guix". 9 years ago
guix Add (guix licenses). 9 years ago
m4 build: Require GNU libgcrypt. 9 years ago
po distro: Go for one module per package. 9 years ago
srfi SRFI-64: Remove use of (ice-9 syntax-case). 9 years ago
tests derivations: Fix erroneous call to `add-to-store' for local files as input. 9 years ago
.dir-locals.el Add (guix ui). 9 years ago
.gitignore Add (guix snix) and the `guix-import' command. 9 years ago
AUTHORS Change email address in `AUTHORS'. 9 years ago
COPYING Add the usual top-level files. 9 years ago
ChangeLog build: Use Automake's `gnu' option. 9 years ago
HACKING doc: Document basic package definitions. 9 years ago
Makefile.am Add (guix licenses). 9 years ago
NEWS build: Use Automake's `gnu' option. 9 years ago
README doc: Mention the pronunciation of "Guix". 9 years ago
ROADMAP doc: Add `ROADMAP'. 9 years ago
THANKS Add `THANKS'. 9 years ago
TODO Augment `TODO'. 9 years ago
configure.ac build: Change bug-report address; add URL. 9 years ago
distro.scm distro: Search bootstrap binaries and patches in %LOAD-PATH. 9 years ago
guix-build.in guix-build: Don't connect to the daemon when run with `--version' or `--help'. 9 years ago
guix-download.in guix-download: Use code from (guix build download). 9 years ago
guix-import.in Add (guix snix) and the `guix-import' command. 9 years ago
guix-package.in guix-package: Extract version strings when installing a direct store path. 9 years ago
guix.scm Remove (guix http) and (guix ftp). 9 years ago
hydra.scm build: Have `hydra.scm' return one job per package. 9 years ago
pre-inst-env.in distro: Search bootstrap binaries and patches in %LOAD-PATH. 9 years ago
release.nix release.nix: Pass `--with-libgcrypt-prefix' in the `tarball' job. 9 years ago

README

-*- mode: org -*-

[[http://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and
associated free software distribution, for the [[http://www.gnu.org/gnu/gnu.html][GNU system]]. In addition
to standard package management features, Guix supports transactional
upgrades and roll-backs, unprivileged package management, per-user
profiles, and garbage collection.

It provides [[http://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded
domain-specific languages (EDSLs) to describe how packages are to be
built and composed.

A user-land free software distribution for GNU/Linux comes as part of
Guix.

Guix is based on the [[http://nixos.org/nix/][Nix]] package manager.


* Hacking

GNU Guix currently depends on the following packages:

- [[http://gnu.org/software/guile/][GNU Guile 2.0.x]]
- [[http://nixos.org/nix/][Nix]]
- [[http://gnupg.org/][GNU libgcrypt]]

Optionally, packages from Nixpkgs may be transparently reused from Guix.
For this to work, you need to have a checkout of the Nixpkgs repository;
the `--with-nixpkgs' option allows you to let `configure' know where the
Nixpkgs checkout is.

- [[http://nixos.org/nixpkgs/][Nixpkgs]]

When building Guix from a checkout, the following packages are also
required:

- [[http://www.gnu.org/software/autoconf/][GNU Autoconf]]
- [[http://www.gnu.org/software/automake/][GNU Automake]]
- [[http://www.gnu.org/software/gettext/][GNU Gettext]]

The "autoreconf -vi" command can be used to generate the build system
infrastructure; it reports an error if an inappropriate version of the
above packages is being used.

* How It Works

Guix does the high-level preparation of a /derivation/. A derivation is
the promise of a build; it is stored as a text file under
=/nix/store/xxx.drv=. The (guix derivations) module provides the
`derivation' primitive, as well as higher-level wrappers such as
`build-expression->derivation'.

Guix does remote procedure calls (RPCs) to the Nix daemon (the
=nix-worker --daemon= command), which in turn performs builds and
accesses to the Nix store on its behalf. The RPCs are implemented in
the (guix store) module.

* Contact

GNU Guix is hosted at https://savannah.gnu.org/projects/guix/.

Please email <bug-guix@gnu.org> for bug reports or questions regarding
Guix and its distribution; email <gnu-system-discuss@gnu.org> for
general issues regarding the GNU system.

Join #guix on irc.freenode.net.

* Guix & Nix

GNU Guix is based on [[http://nixos.org/nix/][the Nix package manager]]. It implements the same
package deployment paradigm, and in fact it reuses some of its code.
Yet, different engineering decisions were made for Guix, as described
below.

Nix is really two things: a package build tool, implemented by a library
and daemon, and a special-purpose programming language. GNU Guix relies
on the former, but uses Scheme as a replacement for the latter.

Using Scheme instead of a specific language allows us to get all the
features and tooling that come with Guile (compiler, debugger, REPL,
Unicode, libraries, etc.) And it means that we have a general-purpose
language, on top of which we can have embedded domain-specific languages
(EDSLs), such as the one used to define packages. This broadens what
can be done in package recipes themselves, and what can be done around them.

Technically, Guix makes remote procedure calls to the ‘nix-worker’
daemon to perform operations on the store. At the lowest level, Nix
“derivations” represent promises of a build, stored in ‘.drv’ files in
the store. Guix produces such derivations, which are then interpreted
by the daemon to perform the build. Thus, Guix derivations can use
derivations produced by Nix (and vice versa).

With Nix and the [[http://nixos.org/nixpkgs][Nixpkgs]] distribution, package composition happens at
the Nix language level, but builders are usually written in Bash.
Conversely, Guix encourages the use of Scheme for both package
composition and builders. Likewise, the core functionality of Nix is
written in C++ and Perl; Guix relies on some of the original C++ code,
but exposes all the API as Scheme.

* Related software

- [[http://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated
software distribution, are the inspiration of Guix
- [[http://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a
symlink tree to create user environments
- [[http://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea
- [[https://live.gnome.org/OSTree/][GNOME's OSTree]] allows bootable system images to be built from a
specified set of packages
- The [[http://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software
distribution; unlike Guix, it relies on core tools available on the
host system