1414codeforge
/
crush
mirror of https://codeberg.org/1414codeforge/crush.git
1
0
Fork 0
Code Packages Projects Releases Activity

[README] Minor docs improvements.

This commit is contained in:
Lorenzo Cogotti 2022-08-15 19:27:56 +02:00
parent f6d42e8b0d
commit 9c143655fc
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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.