From 9c143655fcd8356d76472847364da11f7a775d36 Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Mon, 15 Aug 2022 19:27:56 +0200 Subject: [PATCH] [README] Minor docs improvements. --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d0c0d05..4c08b95 100644 --- a/README.md +++ b/README.md @@ -67,10 +67,18 @@ For example: ```lua { - -- Fetch lib/serialize from https://git.doublefourteen.io/lua/df-serialize - serialize = "https://git.doublefourteen.io/lua/df-serialize", + -- Fetch lib/df-serialize from https://git.doublefourteen.io/lua/df-serialize + -- needs ['quote'] syntax due to '-' + ['df-serialize'] = "https://git.doublefourteen.io/lua/df-serialize", + -- Fetch lib/gear from https://git.doublefourteen.io/lua/gear - gear = "https://git.doublefourteen.io/lua/gear" + gear = "https://git.doublefourteen.io/lua/gear", + + -- Fetch lib/yui from https://git.doublefourteen.io/lua/yui + yui = "https://git.doublefourteen.io/lua/yui" + + -- NOTE: Any dependency may also pull additional subdependencies, + -- these will also be cloned within lib/ } ``` @@ -81,7 +89,7 @@ It obeys the following general rules: `MUST`: -* Be Self-contained, only a single Lua file: `crush.lua`. +* Be self-contained, only a single Lua file: `crush.lua`. * Must only depend on Lua, LÖVE and `git`, expected to be available on any LÖVE developer machine. * Do one thing: fetch the dependencies listed in the `.lovedeps` file. * Be simple and predictable, integrating **crush** into a LÖVE game must be as intuitive as possible. @@ -109,4 +117,4 @@ provide some room for customization. ## License -See [LICENSE](LICENSE) for license information. +See [LICENSE](LICENSE) for detailed information.