commit 1f30b792c0a4df291f165ff6eff7fbaf1b54c525
parent 6530ee13f622d8773c5b06b017f915de6f0d2921
Author: Vincent Demeester <vincent@sbr.pm>
Date: Sat, 14 Mar 2020 12:32:38 +0100
Update README.org in preparation of the future ⚱
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
| M | README.org | | | 113 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------- |
1 file changed, 86 insertions(+), 27 deletions(-)
diff --git a/README.org b/README.org
@@ -1,11 +1,42 @@
#+TITLE: Home configuration files
+#+FILETAGS: @home infra configuration dotfiles
* What is ~home~
:PROPERTIES:
:CUSTOM_ID: h:0272c5ac-0b7f-4ebb-91f0-defa66c2d285
:END:
-This repository is using ~home-manager~ and ~nix~.
+This repository is my dotfiles, using ~home-manager~, ~nix~, some shell script and maybe
+sometimes ansible — especially on non-NixOS system.
+
+The goal of is repository is to be able to have a way to setup dotfiles and packages in
+/one go/, sharing those configuration between multiple computers. The documentation part
+is using (or /will/) =org-mode= following principles of "literate programming": a
+combination of ordinary language and inline code blocks.
+
+This means it could become the /monorepo/ of my configuration, slowly migrating other
+repositories into this one (like [[https://github.com/vdemeester/emacs-config][~emacs-config~]]). This repository should be the source of
+truth of all my configuration.
+
+This will be a all-time work-in-progress, so please beware that things might change
+dramatically or even not working anymore 😛.
+
+* Installation
+:PROPERTIES:
+:CUSTOM_ID: h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c
+:END:
+
+You should be able to run the =bootstrap.sh= script as is. And if you feel adventurous,
+you can use ~curl~ for this.
+
+#+begin_src bash
+curl https://raw.githubusercontent.com/vdemeester/home/master/bootstrap.sh | sh
+#+end_src
+
+Otherwise, clone this repository somewhere, read the =bootstrap.sh= file and execute it if
+you feel safe
+
+** ~home-manager~ only
If you don't have ~nix~ installed, run ~curl https://nixos.org/nix/install | sh~ to install it.
@@ -24,50 +55,78 @@
#+end_src
- run ~nix-shell https://github.com/rycee/home-manager/archive/master.tar.gz -A install~ (maybe twice :D)
-- run ~echo -n "Passphrase: "; read -i PASSPHRASE; env PASSPHRASE=$PASSPHRASE home-manager switch;~
+- run ~home-manager switch;~
-* Goal
-:PROPERTIES:
-:CUSTOM_ID: h:353cadbd-9a24-46af-8a87-72e3b3b822d6
-:END:
-
-The goal of is repository is to be able to have a way to setup dotfiles and packages in
-/one go/, sharing those configuration between multiple computers. The documentation part
-is using (or /will/) =org-mode= following principles of "literate programming": a
-combination of ordinary language and inline code blocks.
+** TODO ~nixos~ only
-This means it could become the /monorepo/ of my configuration, slowly migrating other
-repositories into this one (like [[https://github.com/vdemeester/emacs-config][~emacs-config~]]). This repository should be the source of
-truth of all my configuration.
+TBD: migrate ~nixos-configuration~ here.
-This will be a all-time work-in-progress, so please beware that things might change
-dramatically or even not working anymore 😛.
-
-* TODO Organization of =org-mode=
+* Organization of the repository
:PROPERTIES:
:CUSTOM_ID: h:b74304bf-e7e6-4425-9123-e50eca3eb8fa
:END:
+This is probably gonna be a moving target, but this is how it looks (or should look
+soon-ish 👼):
+
+- ~assets~: ignored folder where my /automation/ puts some /secrets/.
+- ~lib~: shared code used during configuration (mostly ~nix~ code)
+- ~machines~: configuration per machines
+- ~modules~: holds nix modules (services, programs, hardware, profiles, …)
+- ~overlays~: holds [[https://nixos.wiki/wiki/Overlays][nix overlays]]
+- ~pkgs~: holds nix packages (those should migrate under ~overlays~ or on ~nur-packages~)
+- ~tmp~: things to… organize (e.g. where I import my other /legacy/ configuration)
+
As I'm slowly, but _surely_, going to have =org-mode= files for literate configuration
files in this repository, I have to think of how to organize files in order to end up with
-one huge file.
+one huge file. The goal of having those =org-mode= files, is mainly to document my
+configuration and publish it, most likely on [[https://sbr.pm][sbr.pm]].
Let's start by having =org-mode= files in the root folder.
- [[./mails.org][=mails.org=]] holds mail configuration, that becomes more or less the ~profiles.mail~
configuration
-* TODO Nix files and =ansible=
+* References
:PROPERTIES:
-:CUSTOM_ID: h:daf2fc12-0c9f-4008-9aa1-f0c22bdb616d
+:CUSTOM_ID: h:e5a95a68-f031-438b-831c-824803d0bc3e
:END:
-This repository holds [[https://nixos.org/nix/][nix]] files and [[https://www.ansible.com/][ansible]] configurations too. Those two are targeting
-different machines, although, the nix files are used in almost all my machines (whereas
-ansible configuration is just used on non-NixOS setups).
-* References
-
- [[https://willschenk.com/articles/2020/leveraging_disposability_for_exploration/][Leveraging disposability for exploration]]
--
+
+Repositories
+- https://github.com/akirak/nixos-config
+- https://github.com/akirak/home.nix
+- https://github.com/jwiegley/nix-config
+- https://github.com/arianvp/nixos-stuff
+- https://github.com/jwiegley/nix-config
+- https://github.com/leotaku/nixos-config
+- https://github.com/romatthe/ronix
+- https://github.com/rummik/nixos-config
+- https://git.tazj.in/about/
+- https://github.com/a-schaefers/nix-config.old
+- https://github.com/auntieNeo/nixrc
+ + https://github.com/glines/nixrc
+- https://github.com/therealpxc/pxc.nix.d
+- https://github.com/tycho01/nix-config
+- https://github.com/ghuntley/dotfiles-nixos
+- https://github.com/budevg/nix-conf
+- https://github.com/cleverca22/nixos-configs
+- https://github.com/coreyoconnor/nix_configs
+- https://github.com/danieldk/nix-home
+- https://github.com/dejanr/dotfiles
+- https://github.com/Ericson2314/nixos-configuration
+- https://gitlab.com/garry-cairns/nixos-config
+- https://github.com/grahamc/nixos-config
+- https://github.com/HugoReeves/nix-home
+- https://github.com/jwiegley/nix-config
+- https://github.com/kampfschlaefer/nixconfig
+- https://github.com/lambdael/nixosconf
+- https://github.com/puffnfresh/nix-files
+- https://github.com/talyz/nixos-config
+- https://github.com/uwap/nixos-configs
+- https://github.com/yacinehmito/yarn-nix
+- https://github.com/yrashk/nix-home
+
* COPYING
:PROPERTIES:
