From ad56965f9c30bdcf54372fd22d874605c3e90593 Mon Sep 17 00:00:00 2001
From: Mar Alegre <mar@mar.alemor.org>
Date: Mon, 12 Oct 2020 21:09:45 -0400
Subject: [PATCH] added basic readme

---
 README.md | 5 +++++
 TODO.md   | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71755cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+Usage: run `install.sh` to install Podman and custom scripts.
+
+Use `pdm-build` to build a container, `pdm-launch` to launch a container, and `pdm-shell` to run a shell on a container. All three scripts can be invoked with a `-h` to print extented instructions.
+
+build files for different containers are held in the `src` directory
diff --git a/TODO.md b/TODO.md
index 8e64adc..b4d50d0 100644
--- a/TODO.md
+++ b/TODO.md
@@ -6,7 +6,7 @@
   - https://www.gnu.org/software/bash/manual/bash.html#Programmable-Completion
   - https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1
   - https://github.com/scop/bash-completion/blob/master/README.md
-- make container mounts point to /srv/vol
+- make container mounts point to /vol
 - build script: separate params and build file
   - allow overriding of install args 
 	- `-o` flag? pass comma-separated list of overrides?