summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2015-07-16 10:46:15 +0100
committerDaniel Silverstone <dsilvers@digital-scurf.org>2015-07-16 10:46:15 +0100
commita1859fcefffd48651f1086f1bb786d4e4bb83009 (patch)
tree54f3cca5d7aa56fa7e259b8cfbdd41bf7f5a0593
parentf341f72ee27cecf989667e5d1e0c8dcf7a071e1f (diff)
downloadgall-a1859fcefffd48651f1086f1bb786d4e4bb83009.tar.gz
Update README to be more correct
-rw-r--r--README11
1 files changed, 6 insertions, 5 deletions
diff --git a/README b/README
index 351d4e6..9b1502d 100644
--- a/README
+++ b/README
@@ -3,12 +3,13 @@ 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].
+to run external programs and direct access via [libgit2].
-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.git2 so that if the
-system has a git2 module, it won't affect Gall's specific interfaced one.
+In order to provide for platforms where libgit2 is not packaged, Gall submodules
+a libgit2 version into place and binds it using a very simple C/Lua module.
+For platforms which already have libgit2 present, Gall can be built against
+that instead of against the internal copy. For platforms where libgit2
+does not work, Gall can always use the external Git binary instead.
For examples of how to use Gall, see the `examples/` directory.