From 133afd8bfd098b0e6cd2845ab6417a8a5d3ac366 Mon Sep 17 00:00:00 2001 From: Guillaume ARM Date: Sun, 31 May 2026 02:54:08 +0200 Subject: [PATCH] docs: move development guide to dedicated file --- CLAUDE.md | 4 ++++ DEVELOPMENT.md | 13 +++++++++++++ README.md | 17 +++-------------- 3 files changed, 20 insertions(+), 14 deletions(-) create mode 100644 DEVELOPMENT.md diff --git a/CLAUDE.md b/CLAUDE.md index 1f400ad..df2fbf0 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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. diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..d84951e --- /dev/null +++ b/DEVELOPMENT.md @@ -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`. diff --git a/README.md b/README.md index 55269ef..96820b5 100644 --- a/README.md +++ b/README.md @@ -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.