mirror of
https://codeberg.org/1414codeforge/yui.git
synced 2025-02-19 13:20:36 +01:00
[README] Improve wording.
This commit is contained in:
parent
6b7b987940
commit
82f84aa35b
13
README.md
13
README.md
@ -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
|
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.
|
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
|
```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,
|
3. **Yui** can now be downloaded directly by `crush` to the project's `lib` directory:
|
||||||
along with any other dependency:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
lua crush.lua
|
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
|
```lua
|
||||||
local yui = require 'lib.yui'
|
local yui = require 'lib.yui'
|
||||||
```
|
```
|
||||||
|
|
||||||
5. Any project depending on yours may now fetch your project's dependencies (including `yui`)
|
5. Any project depending on yours will now fetch `yui`
|
||||||
automatically using `crush`, following the above procedure.
|
automatically when using `crush`, following the above procedure.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
...Ouch.
|
...Ouch.
|
||||||
|
|
||||||
Documentation and examples are underway, however the source code is (IMHO) sufficiently
|
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
|
## Acknowledgement
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user