This repository is for maintaining Jami package for Guix package manager.

Jan Wielkiewicz 8d8332b6ec Merge branch 'master' of git://git.savannah.gnu.org/guix 4 years ago
build-aux 62b9d3d4d5 git-authenticate: Add daviwil to the list of committers. 4 years ago
doc f9e0488c50 doc: Make sure 'htmlxref.cnf' is honored. 4 years ago
etc d8421fef1d news: Add 'de' translation. 4 years ago
gnu 8d8332b6ec Merge branch 'master' of git://git.savannah.gnu.org/guix 4 years ago
guix 1e44ae6fe7 lint: Check for more packages which should be native. 4 years ago
m4 611a64bd7e build: 'GUIX_CHECK_GUILE_JSON' really checks for Guile-JSON 3.x. 5 years ago
nix be0fb348b8 daemon: Fix the displayed GC estimated progress. 4 years ago
po 11da634a6e Merge branch 'master' into core-updates 5 years ago
scripts 75e24d7b0e pull: Install the new Guix in a profile. 6 years ago
tests d63ee94d63 gexp: Add 'raw-derivation-file'. 4 years ago
.dir-locals.el 55e1dfa4dd ui: Factorize 'with-profile-lock'. 5 years ago
.gitignore 11da634a6e Merge branch 'master' into core-updates 5 years ago
.guix-channel dcc90d1558 Add '.guix-channel' file. 5 years ago
.mailmap 4b3ff36228 Update email for Brett Gilio. 4 years ago
AUTHORS a5b2570a1c AUTHORS: Remove the hand-made list of people. 9 years ago
CODE-OF-CONDUCT a076f19908 CODE-OF-CONDUCT: Switch to version 1.4 of the Contributor Covenant. 6 years ago
COPYING b7a7f59847 Add the usual top-level files. 12 years ago
ChangeLog e793178adb build: Generate a ChangeLog file upon "make dist". 11 years ago
HACKING 2d315cd428 doc: Move "Commit Access" section from 'HACKING' to the manual. 4 years ago
Makefile.am 1e43ab2c03 Add 'build-aux/git-authenticate.scm'. 4 years ago
NEWS c34684b6bc Update NEWS. 5 years ago
README 0758a70cc0 doc: Mention value /var to localstatedir option. 5 years ago
ROADMAP 171a0a13a4 Rename 'dmd' to 'shepherd' in comments and strings. 8 years ago
THANKS 1d743e6bdd Thank Thomas. 8 years ago
TODO b93d2602f7 Update 'TODO' 5 years ago
bootstrap 7bc46ecc34 doc: Add Guix Cookbook. 5 years ago
config-daemon.ac 7738a72186 daemon: GC remove-unused-links phase uses 'statx' when available. 5 years ago
configure.ac c8364ebca8 build: Warn about etc/indent-code.el when Emacs is absent. 5 years ago
d3.v3.js 4d93f312f0 graph: Add d3js backend. 8 years ago
gnu.scm db1e2522f6 Add (gnu system keyboard). 5 years ago
graph.js 4d93f312f0 graph: Add d3js backend. 8 years ago
guix.scm b9b8607824 Add (guix monad-repl). 10 years ago

README

-*- 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

GNU Guix currently depends on the following packages:

- [[https://gnu.org/software/guile/][GNU Guile 2.2.x]]
- [[https://notabug.org/cwebber/guile-gcrypt][Guile-Gcrypt]] 0.1.0 or later
- [[https://www.gnu.org/software/make/][GNU Make]]
- [[https://www.gnutls.org][GnuTLS]] compiled with guile support enabled
- [[https://notabug.org/guile-sqlite3/guile-sqlite3][Guile-SQLite3]], version 0.1.0 or later
- [[https://gitlab.com/guile-git/guile-git][Guile-Git]]
- [[http://www.zlib.net/][zlib]]
- [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]]

Unless `--disable-daemon' was passed, the following packages are needed:

- [[https://gnupg.org/][GNU libgcrypt]]
- [[https://sqlite.org/][SQLite 3]]
- [[https://gcc.gnu.org][GCC's g++]]
- optionally [[http://www.bzip.org][libbz2]]

When `--disable-daemon' was passed, you instead need the following:

- [[https://nixos.org/nix/][Nix]]

* Installation

See the manual for the installation instructions, either by running

info -f doc/guix.info "Installation"

or by checking the [[https://www.gnu.org/software/guix/manual/guix.html#Installation][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 for questions and for bug
reports; email 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