From c0ed1742f8348835a26879173a6f6d589ac4e63f Mon Sep 17 00:00:00 2001
From: Arif Ali <arif.ali@canonical.com>
Date: Tue, 8 Aug 2023 21:28:09 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b406ceb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# slurm-lxd
+
+This is a simple repo to hold some configs and scripts to bootstrap a simple
+slurm environment.
+
+As long as the LXD has been initialised and `lxdbr0` is available, this script
+should work as is. 
+
+It will creete a `slurm-master` and 5 x `slurm-comp0X` nodes
+
+Once ths script finishes, you can login to the master using the command beliow
+
+```
+lxc --project hpc exec slurm-master bash
+```
+
+Now you should be able to run any slurm commands
+