summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..25cb82d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# forge help
+
+This is some code to help new users compile the GO GUI plugins
+which can be rather difficult to figure out how to do.
+
+## Design Goals
+
+* automate the recovery and build process for GO plugins
+* handle input from STDIN when there is no GUI yet
+
+## Notes
+
+Try to make things easy.