X-Git-Url: https://git.hcoop.net/jackhill/guix/guix.git/blobdiff_plain/f1728d43460e63b106dd446e70001d8e100eaf6d..3159fcf14519f02c79ad84b441985982cb1efeb9:/README diff --git a/README b/README index 348a7ada5f..5e9069f80f 100644 --- a/README +++ b/README @@ -10,34 +10,20 @@ It provides [[https://www.gnu.org/software/guile/][Guile]] Scheme APIs, includin 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. +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: +If you are building Guix from source, please see the manual for build +instructions and requirements, either by running: - - [[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 + info -f doc/guix.info "Requirements" -Unless `--disable-daemon' was passed, the following packages are needed: - - - [[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]] +or by checking the [[https://guix.gnu.org/manual/en/html_node/Requirements.html][web copy of the manual]]. * Installation @@ -45,7 +31,7 @@ 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]]. +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. @@ -62,7 +48,8 @@ To do so: - 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!). + new Guix to consider the store to be empty!). We recommend to use the + value '/var'. - Run "make", "make check", and "make install". @@ -74,37 +61,17 @@ the promise of a build; it is stored as a text file under `derivation' primitive, as well as higher-level wrappers such as `build-expression->derivation'. -Guix does remote procedure calls (RPCs) to the Guix or Nix daemon (the -=guix-daemon= or =nix-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. - -* Installing Guix as non-root - -The Guix daemon allows software builds to be performed under alternate -user accounts, which are normally created specifically for this -purpose. For instance, you may have a pool of accounts in the -=guixbuild= group, and then you can instruct =guix-daemon= to use them -like this: - - $ guix-daemon --build-users-group=guixbuild - -However, unless it is run as root, =guix-daemon= cannot switch users. -In that case, it falls back to using a setuid-root helper program call -=nix-setuid-helper=. That program is not setuid-root by default when -you install it; instead you should run a command along these lines -(assuming Guix is installed under /usr/local): - - # chown root.root /usr/local/libexec/nix-setuid-helper - # chmod 4755 /usr/local/libexec/nix-setuid-helper +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 bug reports or questions regarding -Guix and its distribution; email for -general issues regarding the GNU system. +Please email for questions and for bug +reports; email for general issues regarding the +GNU system. Join #guix on irc.freenode.net.