From 1bc282bf486e43d7bebd67b88748fa5780ab1483 Mon Sep 17 00:00:00 2001
From: Kaitlyn Parkhurst <symkat@symkat.com>
Date: Tue, 20 Jul 2021 08:05:18 -0700
Subject: [PATCH] Add installation instructions, manual outline.

---
 Ansible/roles/meshmage/tasks/main.yml |  2 +-
 README.md                             | 44 +++++++++++++++++++++++++--
 2 files changed, 42 insertions(+), 4 deletions(-)

diff --git a/Ansible/roles/meshmage/tasks/main.yml b/Ansible/roles/meshmage/tasks/main.yml
index 124acbf..9b569a9 100644
--- a/Ansible/roles/meshmage/tasks/main.yml
+++ b/Ansible/roles/meshmage/tasks/main.yml
@@ -27,7 +27,7 @@
     state: present
 
 - name: Add the ansible key.
-  ansible.builtin.apt_key:
+  apt_key:
     keyserver: keyserver.ubuntu.com
     id: 93C4A3FD7BB9C367
 
diff --git a/README.md b/README.md
index ed9ad31..18743fd 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
+## Guide
+
+### Installation
+
+MeshMage can be fully installed and configured with Ansible.  From a machine with Ansible and git installed, fork MeshMage and go into the Ansible directory.
+
+```bash
+git clone https://github.com/symkat/MeshMage.git
+cd MeshMage/Ansible
+```
+
+MeshMage should be installed on a Debian 10 machine.  You will need ssh access to `root@` on the target node for Ansible to access it.  Replace the IP address `10.0.0.1` with the IP address of your Debian 10 machine; don't remove the comma inside the single-quotes.
+
+```bash
+ansible-playbook -i '10.0.0.1,' playbooks/install-meshmage.yml
+```
+
+The installation process usually takes about 30 minutes to run.
+
+### Creating the first user account
+
+### Creating a network
+
+### Creating a node
+
+### Creating an SSH key
+
+### Setting up a Linux node
+
+### Setting up a macOS node
+
+### Setting up a Windows node
+
+---
+
 ## Setting Up Development Environment
 
 ### Debian 10
@@ -56,8 +91,7 @@ The previous 4 steps were all done as root.  For this step, you'll need to login
 
 ```bash
 cpanm App::plx App::opan App::Dex Carton Dist::Zilla
-GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" \
-    git clone git@github.com:symkat/MeshMage.git
+git clone https://github.com/symkat/MeshMage.git
 cd MeshMage/DB
 dzil build
 cd ../Web
@@ -65,13 +99,17 @@ plx --init
 plx --config libspec add 00tilde.ll $HOME/perl5
 plx --config libspec add 40dblib.dir ../DB/lib
 plx opan init
-plx opan add ../DB/MeshMage-DB-0.001.tar.gz
+plx opan add ../DB/MeshMage-DB-1.tar.gz
 plx opan merge
 plx opan carton install
 ```
 
 Now you will want to copy Web/meshmage.yml.sample to Web/meshmage.yml and fill out the config file.
 
+```bash
+cp Web/meshmage.yml.sample Web/meshmage.yml
+```
+
 6. Run The App
 
 You'll want to grab a second shell to start the DB.  Make sure you're in the top level directory of MeshMage.