aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuis R. Rodriguez <mcgrof@do-not-panic.com>2012-11-20 02:55:18 -0800
committerLuis R. Rodriguez <mcgrof@do-not-panic.com>2012-11-20 02:55:18 -0800
commit6a5ca90fe62167591262d10d157b2f37c8b0d754 (patch)
treeb393e5f1152bd6caed71741d19515a4bd5bc2401
parent01d7e9c65b33237940ab65c53268a3f0fc2b5f10 (diff)
downloadrel-html-6a5ca90fe62167591262d10d157b2f37c8b0d754.tar.gz
rel-html: add basic README
Signed-off-by: Luis R. Rodriguez <mcgrof@do-not-panic.com>
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89134b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# rel-html
+
+rel-html is designed to parse naked index html pages
+with tarballs on a software project and automatically
+produce a nice shiny HTML5 release page for you. It takes
+as input a configuration file, rel-html.cfg, in which
+you can specify attributes for the release.
+
+# TODO
+
+ * Figure out how to automatically determine releases
+ from git.
+
+ - If we have many stable releases how should
+ we annotate this via git ?
+
+ * See if we can copy the EOL release into an eol/ directory
+ and moving forward instead of parsing the tags use the
+ directory name to automatically determine other release
+ attributes.
+