commit c0ab62f0baed104b95fc53a0a1dedb64d2ea47a0
parent 12a3b2674bfc5900cce1e691b07dafce6f58f314
Author: Vincent Demeester <vincent@sbr.pm>
Date: Sat, 23 May 2020 13:51:34 +0200
Update README and docs
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
3 files changed, 30 insertions(+), 64 deletions(-)
diff --git a/README.md b/README.md
@@ -15,25 +15,22 @@
# What is `home`
-This repository is the monorepo for my personal tools and infrastructure. It containers my
-dotfiles, some tools and scripts. It is mainly based on `nix` and =home-manager=some shell
-script and maybe sometimes ansible — especially on non-NixOS system.
+Veritas is the declarative configuration of my servers, desktops and laptops. This project is based
+on the NixOS operating system and uses home-manager to manage my dotfiles, for both NixOS and
+non-NixOS hosts (like WSL).
-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 repository is the monorepo for my personal tools and the declarative configuration of
+my servers, desktops and laptops. It is based on the NixOS operating system and
+`home-manager` (and some scripts) to manage my dotfiles, for both NixOS and non-NixOS
+hosts (like Fedora, …).
-On idea is also to try to do something like "[Leveraging disposability for exploration](https://willschenk.com/articles/2020/leveraging_disposability_for_exploration/)",
-aka "how to play around without leaving a mess". I'll try my best to make everything
-reproducible and easily testable without making *a mess*. Nix/NixOS should help with that…
+It is fully reproducible (utilizing [niv](https://github.com/nmattia/niv)) and position-independent, meaning there is no
+moving around of `configuration.nix`. For the configurations' entry points see the
+individual [systems](systems), as well as [default.nix](default.nix).
This will be a all-time work-in-progress, so please beware that things might change
dramatically or even not working anymore 😛.
-See [`./tasks.org`](./tasks.md) for the *work-in-progress* — and there is **a lot of work-in-progress**
-👼.
-
<a id="h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c"></a>
@@ -56,23 +53,6 @@ you feel safe
*todo: rework that part*
-If you don't have `nix` installed, run `curl https://nixos.org/nix/install | sh` to install it.
-
-- clone this repository in `$HOME/.config/nixpkgs`
-- create a \`home.nix\` file with the content you want.
- Some machines files already exists that you can use :
-
- { pkgs, ... }:
-
- {
- imports = [
- ./machines/hokkaido.nix
- ];
- }
-
-- run `nix-shell https://github.com/rycee/home-manager/archive/master.tar.gz -A install` (maybe twice :D)
-- run `home-manager switch;`
-
<a id="h:5529fb57-a55d-4b81-a164-e5d1104b7e0b"></a>
@@ -85,6 +65,8 @@ If you don't have `nix` installed, run `curl https://nixos.org/nix/install | sh`
# Organization of the repository
+*todo: rework that part*
+
This is probably gonna be a moving target, but this is how it looks (or should look
soon-ish 👼):
@@ -92,7 +74,7 @@ soon-ish 👼):
Most of the `make` commands will try to populate this ahead of time. The assumption is :
have a `sync` folder where the assets are. *Note: how to bootstrap (as syncthing will
not be there, and the `sync` folder either)*
-- `docs`: holds documentation about this code, literate configuration, see [literate configuration](#org54dd53e).
+- `docs`: holds documentation about this code, literate configuration, see [literate configuration](#org37b6917).
`make publish` will publish the `README.org` and the `docs` folder to my website.
- `lib`: shared code used during configuration (mostly `nix` code).
- `machines`: configuration per machines
@@ -102,7 +84,7 @@ soon-ish 👼):
- `private`: holds non-shareable code, like *secrets*.
- `tmp`: things to… organize (e.g. where I import my other *legacy* configuration)
-<a id="org54dd53e"></a>As I'm slowly, but <span class="underline">surely</span>, going to have `org-mode` files for
+<a id="org37b6917"></a>As I'm slowly, but <span class="underline">surely</span>, 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. The goal of having those `org-mode` files, is
mainly to document my configuration and publish it, most likely on [sbr.pm](https://sbr.pm).
diff --git a/README.org b/README.org
@@ -6,25 +6,22 @@
:CUSTOM_ID: h:0272c5ac-0b7f-4ebb-91f0-defa66c2d285
:END:
-This repository is the monorepo for my personal tools and infrastructure. It containers my
-dotfiles, some tools and scripts. It is mainly based on =nix= and =home-manager=some shell
-script and maybe sometimes ansible — especially on non-NixOS system.
+Veritas is the declarative configuration of my servers, desktops and laptops. This project is based
+on the NixOS operating system and uses home-manager to manage my dotfiles, for both NixOS and
+non-NixOS hosts (like WSL).
-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 repository is the monorepo for my personal tools and the declarative configuration of
+my servers, desktops and laptops. It is based on the NixOS operating system and
+~home-manager~ (and some scripts) to manage my dotfiles, for both NixOS and non-NixOS
+hosts (like Fedora, …).
-On idea is also to try to do something like "[[https://willschenk.com/articles/2020/leveraging_disposability_for_exploration/][Leveraging disposability for exploration]]",
-aka "how to play around without leaving a mess". I'll try my best to make everything
-reproducible and easily testable without making /a mess/. Nix/NixOS should help with that…
+It is fully reproducible (utilizing [[https://github.com/nmattia/niv][niv]]) and position-independent, meaning there is no
+moving around of ~configuration.nix~. For the configurations' entry points see the
+individual [[file:systems][systems]], as well as [[file:default.nix][default.nix]].
This will be a all-time work-in-progress, so please beware that things might change
dramatically or even not working anymore 😛.
-See [[./tasks.org][=./tasks.org=]] for the /work-in-progress/ — and there is *a lot of work-in-progress*
-👼.
-
* TODO Installation
:PROPERTIES:
:CUSTOM_ID: h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c
@@ -49,25 +46,6 @@
/todo: rework that part/
-If you don't have ~nix~ installed, run ~curl https://nixos.org/nix/install | sh~ to install it.
-
-- clone this repository in ~$HOME/.config/nixpkgs~
-- create a `home.nix` file with the content you want.
- Some machines files already exists that you can use :
-
- #+begin_src nix
- { pkgs, ... }:
-
- {
- imports = [
- ./machines/hokkaido.nix
- ];
- }
- #+end_src
-
-- run ~nix-shell https://github.com/rycee/home-manager/archive/master.tar.gz -A install~ (maybe twice :D)
-- run ~home-manager switch;~
-
** TODO ~nixos~ only
:PROPERTIES:
:CUSTOM_ID: h:5529fb57-a55d-4b81-a164-e5d1104b7e0b
@@ -80,6 +58,8 @@
:CUSTOM_ID: h:b74304bf-e7e6-4425-9123-e50eca3eb8fa
:END:
+/todo: rework that part/
+
This is probably gonna be a moving target, but this is how it looks (or should look
soon-ish 👼):
diff --git a/docs/index.org b/docs/index.org
@@ -15,6 +15,10 @@
- One repository to rule all my configurations, for all my machines.
- Reproductible and testable configurations
+On idea is also to try to do something like "[[https://willschenk.com/articles/2020/leveraging_disposability_for_exploration/][Leveraging disposability for exploration]]",
+aka "how to play around without leaving a mess". I'll try my best to make everything
+reproducible and easily testable without making /a mess/. Nix/NixOS should help with that…
+
The following part of this page tries to present an organization to all my
configurations ; but there is a [[file:sitemap.org][sitemap]] if you want to see all the content.
