From 82f84aa35b2399e50a731e897448ca406979eb4d Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Wed, 17 Aug 2022 15:52:18 +0200 Subject: [PATCH] [README] Improve wording. --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ddf2ba1..82b0c42 100644 --- a/README.md +++ b/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 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