aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthew Lemon <lemon@matthewlemon.com>2019-10-21 10:38:19 +0100
committerMatthew Lemon <lemon@matthewlemon.com>2019-10-21 10:38:19 +0100
commit080cf18520562c1611c843a9f8d432ad2275ba1c (patch)
tree72292a407b079bf7ba18de9e45ddbe11fb36533d /README.md
parentadded MIT (diff)
added README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58dee87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+This software is a CLI UI layer for
+[bcompiler-engine]https://github.com/hammerheadlemon/bcompiler-engine). It
+alllows for easy access to adapters available within `bcompiler-engine` and is
+intended to be packaged using a packaging application such as `PyInstaller` and
+thus making `bcompiler-engine` palatable to non-technical users, and users who
+do not have access to a Python installation.
+
+
+Details, including links to the downloadable version of this software are be
+found at [Datamaps - Twenty Four
+Software](https://www.datamaps.twentyfoursoftware.com).