Skip to content

Commit a008572

Browse files
doc(README): add note about using an alias
1 parent 3037008 commit a008572

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ End-users can manage addon installations using the LuaRocks CLI.
2424
- `luarocks --lua-version 5.5 show an-addon` - view information about `an-addon`
2525
- etc.
2626

27+
> [!NOTE]
28+
> To help with remembering to add the `--lua-version 5.5` argument, it may be helpful to add an alias somewhere in your PATH for the command. e.g. on Unix,
29+
>
30+
> ```sh
31+
> #!env bash
32+
> # /in/PATH/lls-addons
33+
> luarocks --lua-version 5.5 "$@"
34+
> ```
35+
>
36+
> and on Windows,
37+
>
38+
> ```bat
39+
> @ECHO OFF
40+
> REM C:\in\PATH\lls-addons.bat
41+
> luarocks --lua-version 5.5 %*
42+
> ```
43+
>
44+
> Then you could just install `an-addon` using `lls-addons install an-addon`.
45+
2746
Users can also browse addons online from https://luarocks.org/m/lls-addons.
2847
2948
### Variables

0 commit comments

Comments
 (0)