Skip to content

Commit 87bc49e

Browse files
committed
doc(README): add a migrating section
1 parent ecb4f9c commit 87bc49e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,11 @@ Addon developers should use an addon file structure like this:
4343
.
4444
├── [addon name]-[version]-[revision].rockspec # required
4545
├── library/ # optional
46-
├── plugin.lua # optional
47-
└── config.json # deprecated
46+
└── plugin.lua # optional
4847
```
4948

5049
See the [Creating an Addon](https://luals.github.io/wiki/addons/#creating-an-addon) section for more information on the individual components.
5150

52-
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.
53-
5451
A `.rockspec` file should be included with the following block:
5552

5653
```lua
@@ -110,6 +107,10 @@ build = {
110107
}
111108
```
112109

110+
### Migrating
111+
112+
A `config.json` file can be included with the addon, but it 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.
113+
113114
## Building
114115

115116
```sh

0 commit comments

Comments
 (0)