From 55b3742f23690dcb4ed22c663bc810fae2dbd75d Mon Sep 17 00:00:00 2001
From: Felix Wittwer <dev@felixwittwer.de>
Date: Wed, 17 Nov 2021 12:29:47 +0100
Subject: [PATCH] Add readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77ffebe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Infrastructure configuration for FSR-operated machines
+
+This repository contains the NixOS configuration files for FSR machines.
+
+
+## Machines configures by this repository:
+- `birne` (the printer notebook)
+- `tomate` (backup endpoint and office computer)
+
+## Setup
+
+Clone this repository on the target machine to `/var/src` and link the folder for the respective machine to the nixos configuration path, e.g.
+
+```bash
+# you may need to delete the newly generated config, but make sure to update
+# the `hardware-configuration.nix` file if necessary
+# rm -rf /etc/nixos
+ln -s /var/src/fruitbasket/birne /etc/nixos
+```
+