Skip to content

Commit ecb4f9c

Browse files
committed
doc(README): spell out addon file structure more explicitly
1 parent 4ff8eaf commit ecb4f9c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,21 @@ You can change the behavior of the installer by defining these variables in a `c
3737

3838
## Usage for Addon Developers
3939

40-
Addon developers should use a similar [addon file structure](https://luals.github.io/wiki/addons/#addon-anatomy) as an old-style addon.
40+
Addon developers should use an addon file structure like this:
41+
42+
```sh
43+
.
44+
├── [addon name]-[version]-[revision].rockspec # required
45+
├── library/ # optional
46+
├── plugin.lua # optional
47+
└── config.json # deprecated
48+
```
49+
50+
See the [Creating an Addon](https://luals.github.io/wiki/addons/#creating-an-addon) section for more information on the individual components.
4151

4252
The `config.json` file is considered deprecated when used with this installer. The `words` and `files` fields will not be read, and the `settings` field is superceded by the rockspec's `build.settings` field.
4353

44-
A rockspec file should be included with the following block:
54+
A `.rockspec` file should be included with the following block:
4555

4656
```lua
4757
build = {

0 commit comments

Comments
 (0)