summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/luakeys/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/luakeys/README.md')
-rw-r--r--macros/luatex/generic/luakeys/README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/macros/luatex/generic/luakeys/README.md b/macros/luatex/generic/luakeys/README.md
index ca73100b64..2bff44088b 100644
--- a/macros/luatex/generic/luakeys/README.md
+++ b/macros/luatex/generic/luakeys/README.md
@@ -144,6 +144,18 @@ local opts = {
local result = luakeys.parse('one,two,three', opts)
```
+## Development
+
+`luakeys` is developed using the
+[Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
+extension in Visual Studio Code. This extension understands the [EmmyLua
+annotations](https://github.com/sumneko/lua-language-server/wiki/EmmyLua-Annotations).
+The Lua source code documentation is generated with
+[LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html).
+
+The Lua code is automatically formatted with the help of the
+[LuaFormatter](https://github.com/Koihik/LuaFormatter).
+
## Tasks
### Installing
@@ -154,6 +166,9 @@ make install
### Testing
+The framework [busted](https://github.com/Olivine-Labs/busted) is used
+for the tests.
+
```
luarocks install busted
busted --exclude-tags=skip test/lua/*.lua
@@ -167,11 +182,14 @@ make test
### Release a new version
+This project uses [semantic versioning](https://semver.org).
+
Update version in:
* luakeys-doc.tex
* luakeys-debug.sty
* luakeys.sty
+* luakeys.lua
Update copyright in:
@@ -185,4 +203,4 @@ Update copyright in:
Summarize the changes in the luakeys-doc.tex as changes.
-Create a new git tag `git tag -sa v0.3`. Prefix the version with ā€œvā€.
+Create a new git tag `git tag -sa 0.7.0`.