X-Git-Url: https://git.hcoop.net/jackhill/guix/guix.git/blobdiff_plain/f0b98b848384f2957a1658a73f0ff20bcec38c23..4f9355c3606ecbe83dce78e6d01fa974d912bd4a:/README diff --git a/README b/README index fe46192acf..348a7ada5f 100644 --- a/README +++ b/README @@ -1,74 +1,65 @@ -*- 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 +[[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 [[http://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded +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. 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. +Guix is based on the [[https://nixos.org/nix/][Nix]] package manager. * Requirements GNU Guix currently depends on the following packages: - - [[http://gnu.org/software/guile/][GNU Guile 2.0.x]], version 2.0.7 or later - - [[http://gnupg.org/][GNU libgcrypt]] - - [[http://www.gnu.org/software/make/][GNU Make]] - - optionally [[http://savannah.nongnu.org/projects/guile-json/][Guile-JSON]], for the 'guix import pypi' command - - optionally [[http://www.gnutls.org][GnuTLS]] compiled with guile support enabled, for HTTPS support - in the 'guix download' command. Note that 'guix import pypi' requires - this functionality. + - [[https://gnu.org/software/guile/][GNU Guile 2.2.x or 2.0.x]], version 2.0.13 or later + - [[https://gnupg.org/][GNU libgcrypt]] + - [[https://www.gnu.org/software/make/][GNU Make]] + - [[https://www.gnutls.org][GnuTLS]] compiled with guile support enabled + - [[https://notabug.org/civodul/guile-sqlite3][Guile-SQLite3]], version 0.1.0 or later + - [[https://gitlab.com/guile-git/guile-git][Guile-Git]] + - [[http://www.zlib.net/][zlib]] + - optionally [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]], for the 'guix import pypi' command Unless `--disable-daemon' was passed, the following packages are needed: - - [[http://sqlite.org/][SQLite 3]] - - [[http://www.bzip.org][libbz2]] - - [[http://gcc.gnu.org][GCC's g++]] + - [[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: - - [[http://nixos.org/nix/][Nix]] + - [[https://nixos.org/nix/][Nix]] * Installation See the manual for the installation instructions, either by running - info -f doc/guix.info "(guix) Installation" + info -f doc/guix.info "Installation" -or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]]. +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 ‘HACKING’ -file. +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: - - Install the dependencies (see 'Requirements' above) and build tools using - Guix: + - Start a shell with the development environment for Guix: - guix package --install autoconf automake bzip2 gcc-toolchain gettext \ - guile libgcrypt pkg-config sqlite - - - Set the environment variables that Guix recommends you to set during the - package installation process: - ACLOCAL_PATH, CPATH, LIBRARY_PATH, PKG_CONFIG_PATH - - - Set the PATH environment variable to refer to the profile: - PATH=$HOME/.guix-profile/bin:$PATH + guix environment guix - Re-run the 'configure' script passing it the option - '--with-libgcrypt-prefix=$HOME/.guix-profile/', as well as '--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!). @@ -119,7 +110,7 @@ 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 +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. @@ -142,7 +133,7 @@ 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 +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 @@ -151,13 +142,13 @@ but exposes all the API as Scheme. * Related software - - [[http://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated + - [[https://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 + - [[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 - - [[http://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea + - [[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 [[http://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software + - 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