commit f39a8fe2816928956f262e2c3f82575f3ac84167
parent 3f1688319d08bfcc65bcf68416400f11cbfe89d7
Author: Vincent Demeester <vincent@sbr.pm>
Date: Fri, 31 Jan 2020 15:41:15 +0100
Move README.md -> README.org 📖
And add the goal for this repository.
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Diffstat:
2 files changed, 32 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,20 +0,0 @@
-# Home configuration files
-
-This repository is using `home-manager` and `nix`.
-
-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 `echo -n "Passphrase: "; read -i PASSPHRASE; env PASSPHRASE=$PASSPHRASE home-manager switch;`
diff --git a/README.org b/README.org
@@ -0,0 +1,32 @@
+#+TITLE: Home configuration files
+
+* What is ~home~
+
+This repository is using ~home-manager~ and ~nix~.
+
+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 ~echo -n "Passphrase: "; read -i PASSPHRASE; env PASSPHRASE=$PASSPHRASE home-manager switch;~
+
+* Goal
+
+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.
+
+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~]]).
