From 6b28cab711313bad9c116c89ecd71229fdc04b95 Mon Sep 17 00:00:00 2001 From: "Collin J. Doering" Date: Sat, 13 Apr 2024 18:35:35 -0400 Subject: [PATCH] README.org: Extend Quickstart and add section on container testing --- README.org | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index 189ed71..ee822be 100644 --- a/README.org +++ b/README.org @@ -17,7 +17,6 @@ These are the dotfiles of the author, managed using guix-home. - ~.guix-authorizations~ :: Guix authorizations file[fn:1] - ~.guix-channel~ :: Guix channel file[fn:2] - ~README.org~ :: Org-mode[fn:3] documentation -- ~TODO.org~ :: Org-mode todo's, known issues and future aspirations - ~home-manifest.scm~ :: Guix manifest used for cuirass builds (and as needed via the cli) - ~user-config~ :: Configuration for various programs managed using guix-home @@ -50,14 +49,35 @@ Home configuration, including startup services (via userland shepherd), configur and installed packages are all managed using [[https://guix.gnu.org][guix]]/[[https://guix.gnu.org/en/manual/devel/en/html_node/Home-Configuration.html][guix-home]] and can be installed with the following. +First, obtain the projects guix channel file. There are two ways to do this; with http +fetching only the channel file, or with git, fetching the entire dotfiles project; the later +is necessary if you plan on [[*Working with Local Sources][Working with Local Sources]]. + +#+begin_src shell + mkdir ~/.dotfiles && curl --output-dir ~/.dotfiles -O https://git.rekahsoft.ca/rekahsoft/dotfiles/raw/branch/master/channels.scm + # OR + git clone https://git.rekahsoft.ca:rekahsoft/dotfiles.git ~/.dotfiles +#+end_src + +Then, use guix to pull the provided channel file and reconfigure guix-home. + #+begin_src shell guix pull -C ~/.dotfiles/channels.scm guix home reconfigure -e '(@ (rekahsoft guix-config home) %home)' #+end_src +** Try it out in a container! + +Thanks to the power of Guix, these dotfiles can be tried out in a container, with the only +prerequisite being guix itself. + +#+begin_src shell + guix time-machine -C ~/.dotfiles/channels.scm -- home container -e '(@ (rekahsoft guix-config home) %home)' +#+end_src + * Working with Local Sources -Clone this repository. +Clone this repository, if you haven't already. #+begin_src shell git clone ~/.dotfiles