1414codeforge/yui
1
0
Fork 0
mirror of https://codeberg.org/1414codeforge/yui.git synced 2025-06-05 22:19:11 +02:00
Code Packages Projects Releases Activity

[README] Improve wording.

Browse Source
This commit is contained in:
Lorenzo Cogotti
2022-08-17 15:52:18 +02:00
parent 6b7b987940
commit 82f84aa35b
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -69,7 +69,7 @@ You should now see a `lib` subdirectory containing the necessary dependencies.
1. Download the latest [crush.lua](https://git.doublefourteen.io/lua/crush/src/branch/master/crush.lua) file and
place it in your project's root directory.
2. Create a `.lovedeps` text file in your project's root with the following dependency entry:
2. Create a `.lovedeps` text file in your project's root with the following entry:
```lua
{
@@ -79,28 +79,27 @@ You should now see a `lib` subdirectory containing the necessary dependencies.
}
```
3. **Yui** can now be downloaded directly by `crush` to the project's `lib` directory,
along with any other dependency:
3. **Yui** can now be downloaded directly by `crush` to the project's `lib` directory:
```sh
lua crush.lua
```
4. You may now use `yui` in your project by `require()`-ing it.
4. Now `yui` can be `require()`d in your code, like this:
```lua
local yui = require 'lib.yui'
```
5. Any project depending on yours may now fetch your project's dependencies (including `yui`)
automatically using `crush`, following the above procedure.
5. Any project depending on yours will now fetch `yui`
automatically when using `crush`, following the above procedure.
## Documentation
...Ouch.
Documentation and examples are underway, however the source code is (IMHO) sufficiently
straightforward and disciplined to have sufficient overview of the functionality.
straightforward and disciplined to have a decent overview of the functionality.
## Acknowledgement