summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..03851f3
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+Git Abstraction Layer for Lua
+=============================
+
+Gall is an abstraction layer to provide access to Git repositories for Lua
+programs. It combines access via the Git binaries by use of [Luxio]'s ability
+to run external programs and direct access via [luagit2].
+
+In order to make the [luagit2] binding marginally more stable for Gall, it
+includes both [luagit2] and [libgit2] via submodules and builds them statically
+together into a git2 module which it installs as gall.internal.git2 so that if
+the system has a git2 module, it won't affect Gall's specific interfaced one.
+
+For examples of how to use Gall, see the `examples/` directory.
+
+[Luxio]: http://www.rjek.com/software.html
+[luagit2]: http://www.github.com/libgit2/luagit2/
+