-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
76e8dd0
commit 176ae88
Showing
1 changed file
with
10 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,21 @@ | ||
| # simple-luv | ||
| A self-contained binary CLI that helps with setting up for a new project or for future projects for Luvit. Supports Windows and Linux but Linux hasn't been tested | ||
|
|
||
| # Installation | ||
| You can get the latest release [here](https://github.com/alphafantomu/simple-luv/releases/latest), only Windows x64 binaries are provided. | ||
|
|
||
| # Build | ||
| Install [Luvi](https://github.com/luvit/luvi), change to the SimpleLuv directory and run `luvi . -o simpleluv` | ||
| Install [lit](https://github.com/luvit/lit), change to the SimpleLuv directory and run `lit make .' | ||
|
|
||
| # Usage | ||
| - `--version` `-v`: Shows current SimpleLuv version | ||
| - `--setup` `-s` [location]: Moves Luvit, Luvi, and Lit binaries to a global binary directory then adds that directory to PATH, LUA_PATH and LUA_CPATH is adjusted to have an easy require in project folder. | ||
| - `--help` `-h`: Shows the help menu | ||
| - `--githublink` `-gl` [paths]: Links libraries to the project directory for SumNeko's LLS but starts in Github Desktop's Repository Directory | ||
| - `--link` `-l` [paths]: Links libraries to the project directory with relative or absolute paths | ||
| - `--gitignore` `-gi`: Creates a .gitignore file for the project directory, used for ignoring certain file extensions like .dll and .so. | ||
| - `--editorconfig` `-ec`: Creates a .editorconfig for the proejct directory, used for tabbing when reading code from GitHub Repositories. | ||
| - `simpleluv setup` Moves Luvit, Luvi, and Lit binaries to a global binary directory then | ||
| - `simpleluv link <...>` Links libraries to the project directory with relative or absolute paths, usable only for VSCode | ||
| - `simpleluv githublink <...>` Links libraries to the project directory starting in Github Desktop's Repository Directory, usable only for VSCode | ||
| - `simpleluv gitignore` Creates a .gitignore file for the project directory, used for ignoring file extensions like .dll and .so. | ||
| - `simpleluv editorconfig` Creates a .editorconfig for the proejct directory, used for tabbing when reading code from GitHub Repositories. | ||
|
|
||
| # License | ||
| [MIT License](LICENSE) | ||
|
|
||
| # Contact | ||
| - Discord: `Arivistraliavatoriar#2678` | ||
| - Discord: `Arivistraliavatoriar#2678` |