docs: move development guide to dedicated file

This commit is contained in:
Guillaume ARM 2026-05-31 02:54:08 +02:00
parent c10b28dbc0
commit 133afd8bfd
3 changed files with 20 additions and 14 deletions

View File

@ -62,3 +62,7 @@ These are duplicated as local constants across files; keep them in sync when cha
- Each module starts with `local _VERSION = '...'`; bump it when changing that module's behavior.
- Programs accept `-version`/`--version` and `-help`/`--help` (and `-silent`/`--silent` for the router) via vararg `...`.
- French comments appear throughout — fine to add either language, match the surrounding file.
## Development setup
See `DEVELOPMENT.md` for local development requirements and setup steps.

13
DEVELOPMENT.md Normal file
View File

@ -0,0 +1,13 @@
# Development
Requirements:
- `just`
- `luacheck`
After cloning the repository, run:
```sh
just install
```
This installs the local Git hooks, including a pre-push hook that runs `just check`.

View File

@ -1,19 +1,5 @@
# Trap's ComputerCraft APIs
## Development
Requirements:
- `just`
- `luacheck`
After cloning the repository, run:
```
just install
```
This installs the local Git hooks, including a pre-push hook that runs `just check`.
## Installation
```
wget run https://raw.githubusercontent.com/guillaumearm/cc-libs/master/install.lua
@ -35,3 +21,6 @@ All servers are automatically started at boot
- `ping` : ping machines (use `apis/net`)
- `cube`: cube client for deployment (use `cube help` command for more details)
- `goo`: turtle program for Just Dire Things goo block processing.
## Development
See [DEVELOPMENT.md](./DEVELOPMENT.md) for development setup and workflow.