From b1a516582e9536b9b371749391d138e1d7b64bdb Mon Sep 17 00:00:00 2001
From: James Tomasino <james@tomasino.org>
Date: Tue, 27 Nov 2018 14:21:15 -0500
Subject: [PATCH] added readme

---
 README.md                                     | 27 +++++++++++++++++++
 bin/cosmic-web                                |  2 +-
 .../webheader.tmpl                            |  0
 3 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 rename files/web-header.tmpl => templates/webheader.tmpl (100%)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b53a56c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# cosmic.voyage scripts
+
+## bin
+
+### Administration
+
+- `cosmic-backup` cron-run backup of /var/gopher to git repo
+- `cosmic-rss` cron-run creation of rss feed for web and gopher
+- `cosmic-ship` create a new ship and assign it to a given user
+- `cosmic-user` create a new user and scaffold them into the story
+- `cosmic-web` cron-run creation of html version of the story
+
+### User
+
+- `cosmic-log` aliased as `log` - submit messages to the QEC relay
+- `cosmic-roster` aliased as `roster` - show current users and their ships
+- `cosmic-motd` aliased as `motd` - pretty-prints the motd
+
+## files
+
+- `motd` message of the day, records recent updates to the system
+
+## templates
+
+- `web-header.tmpl` - template for web generation
+- `newship.tmpl` - email template for adding new ship for user
+- `welcomeemail.tmpl` - email template for new users added to system
diff --git a/bin/cosmic-web b/bin/cosmic-web
index 5b20668..8b64e73 100755
--- a/bin/cosmic-web
+++ b/bin/cosmic-web
@@ -6,7 +6,7 @@ if [ "$run_user" -eq 0 ]; then
   SCRIPTPATH=$(dirname "$SCRIPT")
 
   file_html="/var/www/html/index.html"
-  web_header_html="${SCRIPTPATH}/../files/web-header.tmpl"
+  web_header_html="${SCRIPTPATH}/../templates/webheader.tmpl"
   ships_html="/var/www/html/ships/index.html"
   error_html="/var/www/html/error.html"
   html_dir="/var/www/html"
diff --git a/files/web-header.tmpl b/templates/webheader.tmpl
similarity index 100%
rename from files/web-header.tmpl
rename to templates/webheader.tmpl