aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README23
1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
index b9f36f8344..31d3197788 100644
--- a/README
+++ b/README
@@ -1,5 +1,28 @@
-*- mode: org -*-
+This is [[https://koszko.org/koszko.html][Wojtek]]'s Guix fork. It serves as a home for personal modifications
+and additions that for some reason aren't in upstream Guix. These may include
+package and service definitions, as well as changes to Guix itself. You're
+free to clone this repository and use it for your own needs. But if you
+choose to do so, please be ready to deal with some peculiarities.
+
+- The tip this repository is intended to be frequently rebased on top of
+ upstream Guix so expect ~git pull~ to complain.
+- As a result of the rebasing approach, the ~--allow-downgrades~ flag has to
+ be used when running ~guix pull~ or ~guix (system|home) reconfigure~.
+- As another result of the rebasing approach, there's no PGP authorization (it
+ would not be possible to provide it reliably). The =.guix-authorizations=
+ file is removed by one of the tip commits to remove the warning from ~guix
+ pull~.
+- If you don't know what all this means, this is probably not for you. Try
+ [[https://guix.gnu.org/][upstream Guix]] instead :)
+
+Feel free to look into the ~koszko-scripts~ branch to see the scripts I am
+using to maintain this thing. Note they might prove pretty useless to you.
+
+
+* The original README introduction
+
[[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