Skip to content

Commit 59a98aa

Browse files
committed
Document LuaRocks-based dependencies
1 parent dae16d9 commit 59a98aa

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ This repo is a larger reference game for building with Tecs and Tecs2D in Teal.
1111
- `tecs integ`: compile `spec/**/*.tl` and run it with the bundled busted runner;
1212
`spec/game_lovespec.tl` boots the built game under real LÖVE and drives it over MCP.
1313
Not headless; macOS and Linux only.
14-
- `tecs add <rock>[@version]` / `tecs remove <rock>` / `tecs update`: vendor pure-Lua rocks
15-
(and their Teal type declarations) from luarocks.org into `src/vendor/`. The committed
16-
`tecs-rocks.lua` records them; check/build restore missing rocks from it.
14+
- Dependencies: vendor pure-Lua rocks with LuaRocks
15+
(`luarocks install --tree src/vendor --lua-version=5.1 <rock>`, plus the matching
16+
`<rock>-tl-type` rock for Teal declarations). `src/vendor/` is gitignored; record
17+
installed rocks somewhere repeatable.
1718
- `tecs info --json`: CLI/runtime versions and project status for tooling.
1819
- `tecs clean`: remove build output.
1920
- `tecs dev`: prepare local Tecs source for development iteration.
@@ -86,8 +87,8 @@ For an even smaller starting point, keep `tecs2d.run({ game = require("plugins.g
8687
- Keep new comments short and useful; this reference project should remain easy to scan.
8788
- Do not edit `build/` directly.
8889
- Do not remove third-party asset credit/license files unless the corresponding asset is removed too.
89-
- Vendor third-party pure-Lua rocks with `tecs add <rock>` (never a LuaRocks installation);
90-
commit the generated `tecs-rocks.lua`. Keep project-owned Teal modules under `src/`.
90+
- Vendor third-party pure-Lua rocks with LuaRocks into `src/vendor/` and record them
91+
somewhere repeatable. Keep project-owned Teal modules under `src/`.
9192
- If you add new files under `src/`, verify they are included by `tecs build`.
9293

9394
## CI

‎README.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,6 @@ demonstrate the opt-in.
8585
| `tecs build` | Compile without running |
8686
| `tecs check` | Type-check all Teal source files (`--json` for tooling) |
8787
| `tecs integ` | Run `spec/`; `game_lovespec.tl` drives the built game over MCP |
88-
| `tecs add <rock>` | Vendor a pure-Lua rock and its Teal types from luarocks.org |
89-
| `tecs remove <rock>` | Remove a vendored rock |
90-
| `tecs update` | Update vendored rocks to their newest versions |
9188
| `tecs clean` | Remove build artifacts |
9289
| `tecs info` | Show CLI/runtime versions and project status (`--json` for tooling) |
9390
| `tecs agent` | List bundled agent guides or print one's installed path |

0 commit comments

Comments
 (0)