commit 233e70a4e64a657cdb95b47af9f3f93dbf7ffb45
parent f4cc01a45c5da7d1c6deadc167e14b87fb3ff66b
Author: Vincent Demeester <vincent@sbr.pm>
Date: Thu, 26 Nov 2020 17:52:31 +0100
Update README and envrc
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
| M | .envrc | | | 2 | ++ |
| M | README.md | | | 90 | +++++++++++++++++++++++++++----------------------------------------------------- |
| M | README.org | | | 83 | +++++++++++++++++-------------------------------------------------------------- |
3 files changed, 50 insertions(+), 125 deletions(-)
diff --git a/.envrc b/.envrc
@@ -1,3 +1,5 @@
# use_nix shell.nix
test -f .secrets && source .secrets || echo "no secrets"
export QEMU_OPTS="-m 8096 -cpu host"
+export PATH="${PWD}/bin:${PATH}"
+export REPO_ROOT="${PWD}"
diff --git a/README.md b/README.md
@@ -1,71 +1,53 @@
# Table of Contents
-1. [What is `home`](#h:0272c5ac-0b7f-4ebb-91f0-defa66c2d285)
-2. [Installation](#h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c)
-3. [Organization of the repository](#h:b74304bf-e7e6-4425-9123-e50eca3eb8fa)
-4. [References](#h:e5a95a68-f031-438b-831c-824803d0bc3e)
-5. [COPYING](#h:716e598e-3b1a-4e48-a72b-608c3a970db9)
+1. [Highlights](#org955d5f4)
+ 1. [Systems](#orgb1330e3)
+ 2. [Tools](#orgb798790)
+ 3. [User(s)](#org075b62a)
+2. [References](#orgdf5348e)
+3. [Licensing](#orge77bd17)
-
+`home` is the monorepo containing my personal tools and infrastructure. Everything in here
+should be built using [Nix](https://nixos.org/nix).
-<a id="h:0272c5ac-0b7f-4ebb-91f0-defa66c2d285"></a>
+<a id="org955d5f4"></a>
-# What is `home`
+# Highlights
-`home` 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).
-
-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, …).
-
-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).
+It is meant to be fully reproducible (using [niv](https://github.com/nmattia/niv) for now) 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 😛.
-<a id="h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c"></a>
+<a id="orgb1330e3"></a>
+
+## Systems
-# TODO Installation
+This holds the configuration of my different systems. It is meant to be
+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).
-*todo: rework that part, link to the `docs` folder*
+<a id="orgb798790"></a>
-<a id="h:b74304bf-e7e6-4425-9123-e50eca3eb8fa"></a>
+## Tools
-# Organization of the repository
+Those are tools I have written for my personal usage.
-*todo: rework that part*
-This is probably gonna be a moving target, but this is how it looks (or should look
-soon-ish 👼):
+<a id="org075b62a"></a>
-- `docs`: holds documentation about this code, literate configuration, see [literate configuration](#orgaddf58b).
- `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
-- `modules`: holds nix modules (services, programs, hardware, profiles, …)
-- `overlays`: holds [nix overlays](https://nixos.wiki/wiki/Overlays)
-- `pkgs`: holds nix packages (those should migrate under `overlays` or on `nur-packages`)
-- `secrets`: holds non-shareable code, this folder is ignored and `make` commands will try
- to populate this. If it's empty, the rest of configuration is still meant to work but
- will contain empty secrets (or random ones).
-- `tmp`: things to… organize (e.g. where I import my other *legacy* configuration)
+## User(s)
-<a id="orgaddf58b"></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).
+Users configuration, for [NixOS](https://nixos.org) and using home-manager.
-<a id="h:e5a95a68-f031-438b-831c-824803d0bc3e"></a>
+<a id="orgdf5348e"></a>
# References
@@ -118,21 +100,9 @@ Repositories
- <https://github.com/hlissner/dotfiles/>
-<a id="h:716e598e-3b1a-4e48-a72b-608c3a970db9"></a>
-
-# COPYING
-
-Copyright (c) 2018-2020 Vincent Demeester <vincent@sbr.pm>
-
-This file is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation, either version 3 of the License, or (at
-your option) any later version.
+<a id="orge77bd17"></a>
-This file is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
+# Licensing
-You should have received a copy of the GNU General Public License
-along with this file. If not, see <http://www.gnu.org/licenses/>.
+Unless otherwise stated in a subdirectory, all code is licensed under the GNU GPL v3. See
+[COPYING](COPYING) for details.
diff --git a/README.org b/README.org
@@ -1,68 +1,35 @@
# -*- mode: org; eval: (add-hook 'after-save-hook (lambda () (org-md-export-to-markdown)) nil t) -*-
-#+TITLE: Home configuration files
+#+TITLE: =home= monorepo
#+FILETAGS: #home infra configuration dotfiles
-[[https://builds.sr.ht/~vdemeester/home.svg]]
+~home~ is the monorepo containing my personal tools and infrastructure. Everything in here
+should be built using [[https://nixos.org/nix][Nix]].
-* What is ~home~
-:PROPERTIES:
-:CUSTOM_ID: h:0272c5ac-0b7f-4ebb-91f0-defa66c2d285
-:END:
+* Highlights
-~home~ 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).
-
-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, …).
-
-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]].
+It is meant to be fully reproducible (using [[https://github.com/nmattia/niv][niv]] for now) 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 😛.
-* TODO Installation
-:PROPERTIES:
-:CUSTOM_ID: h:e289aa81-d0ec-49a0-ba94-933e85d4ee8c
-:END:
+** Systems
-/todo: rework that part, link to the =docs= folder/
+This holds the configuration of my different systems. It is meant to be
+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]].
-* Organization of the repository
-:PROPERTIES:
-:CUSTOM_ID: h:b74304bf-e7e6-4425-9123-e50eca3eb8fa
-:END:
+** Tools
-/todo: rework that part/
+Those are tools I have written for my personal usage.
-This is probably gonna be a moving target, but this is how it looks (or should look
-soon-ish 👼):
+** User(s)
-- ~docs~: holds documentation about this code, literate configuration, see [[literate configuration][literate configuration]].
- =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
-- ~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~)
-- ~secrets~: holds non-shareable code, this folder is ignored and =make= commands will try
- to populate this. If it's empty, the rest of configuration is still meant to work but
- will contain empty secrets (or random ones).
-- ~tmp~: things to… organize (e.g. where I import my other /legacy/ configuration)
+Users configuration, for [[https://nixos.org][NixOS]] and using home-manager.
-<<literate 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. 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]].
* References
-:PROPERTIES:
-:CUSTOM_ID: h:e5a95a68-f031-438b-831c-824803d0bc3e
-:END:
Repositories
- [[https://github.com/lovesegfault/nix-config][https://github.com/lovesegfault/nix-config]]
@@ -110,22 +77,8 @@
- [[https://github.com/Baughn/machine-config]]
- https://github.com/hlissner/dotfiles/
-* COPYING
-:PROPERTIES:
-:CUSTOM_ID: h:716e598e-3b1a-4e48-a72b-608c3a970db9
-:END:
-
-Copyright (c) 2018-2020 Vincent Demeester <vincent@sbr.pm>
-
-This file is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation, either version 3 of the License, or (at
-your option) any later version.
-This file is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
+* Licensing
-You should have received a copy of the GNU General Public License
-along with this file. If not, see <http://www.gnu.org/licenses/>.
+Unless otherwise stated in a subdirectory, all code is licensed under the GNU GPL v3. See
+[[file:COPYING][COPYING]] for details.
