gnu: Add python-activepapers.
[jackhill/guix/guix.git] / README
diff --git a/README b/README
index 98e38b4..18e6856 100644 (file)
--- a/README
+++ b/README
@@ -1,71 +1,75 @@
 -*- 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]]
-  - [[http://gnupg.org/][GNU libgcrypt]]
+  - [[https://gnu.org/software/guile/][GNU Guile 2.2.x or 2.0.x]], version 2.0.9 or later
+  - [[https://gnupg.org/][GNU libgcrypt]]
+  - [[https://www.gnu.org/software/make/][GNU Make]]
+  - optionally [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]], for the 'guix import pypi' command
+  - optionally [[https://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.
 
 Unless `--disable-daemon' was passed, the following packages are needed:
 
-  - [[http://sqlite.org/][SQLite 3]]
+  - [[https://sqlite.org/][SQLite 3]]
   - [[http://www.bzip.org][libbz2]]
-  - [[http://gcc.gnu.org][GCC's g++]]
+  - [[https://gcc.gnu.org][GCC's g++]]
 
 When `--disable-daemon' was passed, you instead need the following:
 
-  - [[http://nixos.org/nix/][Nix]]
+  - [[https://nixos.org/nix/][Nix]]
 
-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.
+* Installation
 
-  - [[http://nixos.org/nixpkgs/][Nixpkgs]]
+See the manual for the installation instructions, either by running
 
-When building Guix from a checkout, the following packages are also
-required:
+  info -f doc/guix.info "Installation"
 
-  - [[http://www.gnu.org/software/autoconf/][GNU Autoconf]]
-  - [[http://www.gnu.org/software/automake/][GNU Automake]]
-  - [[http://www.gnu.org/software/gettext/][GNU Gettext]]
+or by checking the [[https://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]].
 
-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.
+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) using Guix
-  - re-run the configure script passing it the option
-    `--with-libgcrypt-prefix=$HOME/.guix-profile/'
-  - run "make" and "make install"
+  - 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!).
+
+  - 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
-=/nix/store/xxx.drv=.  The (guix derivations) module provides the
+=/gnu/store/xxx.drv=.  The (guix derivations) module provides the
 `derivation' primitive, as well as higher-level wrappers such as
 `build-expression->derivation'.
 
@@ -105,7 +109,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.
@@ -128,7 +132,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
@@ -137,13 +141,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