diff options
author | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-07-01 11:35:59 +0100 |
---|---|---|
committer | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-07-01 11:35:59 +0100 |
commit | dc4db1f7a8750fb44e5677199c5e276b0db848b3 (patch) | |
tree | 7b3eaa26a2380796b8b6bcecd9d9c4c1637c2c35 | |
parent | 852bd890b7611653aaa93d74f37edec9bd5e984f (diff) | |
download | gall-dc4db1f7a8750fb44e5677199c5e276b0db848b3.tar.gz |
Cleanup README and Makefile a bitrichardmaw/gall-ref-filepath-resolvedsilvers/correct-testing
-rw-r--r-- | Makefile | 4 | ||||
-rw-r--r-- | README | 16 |
2 files changed, 8 insertions, 12 deletions
@@ -64,10 +64,6 @@ clean: distclean: clean find . -name "*~" -delete -.PHONY: example -example: - $(LUA) example/gall-example.lua - .PHONY: test test: cmodule @$(RM) luacov.stats.out; \ @@ -5,14 +5,14 @@ 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 [libgit2]. -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 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. +Note, gall should work with Lua 5.1, 5.2, and 5.3; but the test suite run by +the Makefile requires at least 5.2 in order to blacklist any system gall module +present. We recommend that any packaging should build-conflict with an +installed gall module in order to ensure build-time tests are clean. -[Luxio]: http://www.rjek.com/software.html -[luagit2]: http://www.github.com/libgit2/luagit2/ +[Luxio]: https://git.gitano.org.uk/luxio.git/ +[luagit2]: https://github.com/libgit2/luagit2/ |