From 43ebf2c502e1f1ba9e9a50a861b17dfc196b05da Mon Sep 17 00:00:00 2001
From: linus <linus@fsfe.org>
Date: Mon, 15 Nov 2021 19:09:23 +0100
Subject: [PATCH] add rudimentary README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8da667
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+
+**Table of Contents**
+
+- [Motivation](#motivation)
+- [Install](#install)
+  - [Clone the repo](#clone-the-repo)
+  - [Build binaries from submodule at `./innernet-src`](#build-binaries-from-submodule-at-innernet-src)
+  - [Run the playbook](#run-the-playbook)
+
+<!-- markdown-toc end -->
+
+# Motivation
+
+# Install
+
+## Clone the repo
+
+```bash
+git clone --recurse-submodules git@git.fsfe.org:fsfe-system-hackers/innernet-playbook.git
+cd innernet-playbook
+```
+
+## Build binaries from submodule at `./innernet-src`
+
+Since [innernet](https://github.com/tonarino/innernet) is new software, it is not yet included in the Debian repositories. Thus, before running the playbook we need to build the `innernet` and `innernet-server` binaries. At the moment, we are using `v1.5.1`, but you can choose any other available version by setting the environment variable accordingly.
+
+```bash
+INNERNET_VERSION=v1.5.1 ./build.sh
+```
+
+## Run the playbook
+
+```bash
+ansible-playbook playbook.yml
+```
+
+## Distribute the invitation files
+
+Some invitation files are for humans, so you need to send these files to them securely. I suggest using someting like `wormohle`.
+
+```bash
+sudo apt install magic-wormhole
+cd roles/client/files
+wormhole send <name_of_peer>.toml
+```