[README] Minor docs improvements.

master
Lorenzo Cogotti 2 years ago
parent f6d42e8b0d
commit 9c143655fc

@ -67,10 +67,18 @@ For example:
```lua ```lua
{ {
-- Fetch lib/serialize from https://git.doublefourteen.io/lua/df-serialize -- Fetch lib/df-serialize from https://git.doublefourteen.io/lua/df-serialize
serialize = "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 -- 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`: `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. * 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. * 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. * 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 ## License
See [LICENSE](LICENSE) for license information. See [LICENSE](LICENSE) for detailed information.

Loading…
Cancel
Save