Guix/GuixSD development repository; official: http://git.savannah.gnu.org/cgit/guix.git
Go to file
Collin J. Doering 9304f6e9cd
gnu: Add emacs-persp-projectile
Signed-off-by: Collin J. Doering <collin@rekahsoft.ca>
2020-08-05 20:56:56 -04:00
build-aux maint: Remove 'build-aux/git-authenticate.scm'. 2020-07-11 12:33:10 +02:00
doc services: Add zram-device-service. 2020-08-02 15:54:37 +03:00
etc guix-install.sh: Make sure /etc/profile is sourced. 2020-07-16 20:12:07 +02:00
gnu gnu: Add emacs-persp-projectile 2020-08-05 20:56:56 -04:00
guix guix: lint: Ignore unsupported source URL’s. 2020-08-01 08:30:57 +02:00
m4 ssh: Speed up RPCs by using #:nodelay. 2020-07-20 23:25:09 +02:00
nix daemon: Recognize SHA3 and BLAKE2s. 2020-06-27 23:42:20 +02:00
po nls: Update 'fr' translation. 2020-07-27 12:06:37 +02:00
scripts pull: Install the new Guix in a profile. 2018-06-09 12:02:27 +02:00
tests services: Add zram-device-service. 2020-08-02 15:54:37 +03:00
.dir-locals.el deduplication: Use 'dynamic-wind' when changing permissions of the parent. 2020-06-25 12:29:22 +02:00
.envrc Add .envrc file 2020-08-02 12:45:58 -04:00
.gitignore gitignore: Don't ignore daemon source code. 2020-07-17 15:23:53 +02:00
.guix-authorizations .guix-authorizations: Add brettgilio (back) to the committers. 2020-07-18 21:12:38 +02:00
.guix-channel .guix-channel: Add primary URL. 2020-06-17 19:32:43 +02:00
.mailmap mailmap: Update for self. 2020-05-15 09:08:46 +02:00
AUTHORS AUTHORS: Remove the hand-made list of people. 2015-07-19 21:49:58 +02:00
CODE-OF-CONDUCT CODE-OF-CONDUCT: Switch to version 1.4 of the Contributor Covenant. 2018-05-29 18:29:36 +02:00
COPYING Add the usual top-level files. 2012-06-03 23:46:56 +02:00
ChangeLog build: Generate a ChangeLog file upon "make dist". 2013-05-12 16:35:17 +02:00
HACKING doc: Move "Commit Access" section from 'HACKING' to the manual. 2020-01-09 23:33:04 +01:00
Makefile.am maint: 'authenticate' runs the user's 'guix git authenticate'. 2020-07-27 12:06:37 +02:00
NEWS Update NEWS. 2020-04-15 00:02:23 +02:00
README doc: Update README to refer to the manual. 2020-06-02 18:55:53 +02:00
ROADMAP Rename 'dmd' to 'shepherd' in comments and strings. 2016-01-29 20:21:54 +03:00
THANKS Thank Thomas. 2016-07-18 06:56:29 +02:00
TODO Update 'TODO' 2019-01-21 09:59:41 +01:00
bootstrap bootstrap: Fix typo. 2020-02-17 11:49:08 +01:00
config-daemon.ac daemon: GC remove-unused-links phase uses 'statx' when available. 2019-11-27 00:03:03 +01:00
configure.ac etc: Add committer script. 2020-06-16 11:32:53 +02:00
d3.v3.js graph: Add d3js backend. 2016-12-14 21:58:32 +01:00
gnu.scm Use 'formatted-message' instead of '&message' where appropriate. 2020-07-25 19:11:37 +02:00
graph.js graph: Add d3js backend. 2016-12-14 21:58:32 +01:00
guix.scm Add (guix monad-repl). 2014-08-15 16:26:28 +02:00

README

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

-*- mode: org -*-

[[https://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and
associated free software distribution, for the [[https://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 [[https://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.

GNU Guix can be used on top of an already-installed GNU/Linux distribution, or
it can be used standalone (we call that “Guix System”).

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


* Requirements

If you are building Guix from source, please see the manual for build
instructions and requirements, either by running:

  info -f doc/guix.info "Requirements"

or by checking the [[https://guix.gnu.org/manual/en/html_node/Requirements.html][web copy of the manual]].

* Installation

See the manual for the installation instructions, either by running

  info -f doc/guix.info "Installation"

or by checking the [[https://guix.gnu.org/manual/en/html_node/Installation.html][web copy of the manual]].

For information on installation from a Git checkout, please see the section
"Building from Git" in the manual.

* Installing Guix from Guix

You can re-build and re-install Guix using a system that already runs Guix.
To do so:

  - Start a shell with the development environment for Guix:

      guix environment guix

  - Re-run the 'configure' script passing it the option
    '--localstatedir=/somewhere', where '/somewhere' is the 'localstatedir'
    value of the currently installed Guix (failing to do that would lead the
    new Guix to consider the store to be empty!).  We recommend to use the
    value '/var'.

  - Run "make", "make check", and "make install".

* 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
=/gnu/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 build daemon (the =guix-daemon=
command), which in turn performs builds and accesses to the 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 <help-guix@gnu.org> for questions and <bug-guix@gnu.org> for bug
reports; 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 [[https://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 [[https://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

  - [[https://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated
    software distribution, are the inspiration of Guix
  - [[https://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a
    symlink tree to create user environments
  - [[https://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 [[https://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