aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Mathes <adam@adammathes.com>2026-02-18 08:42:40 -0800
committerAdam Mathes <adam@adammathes.com>2026-02-18 08:42:40 -0800
commit4e1d5662353c3d54d3edb9cfe07893bcc56e331b (patch)
tree37bd3f94c3bb4d8926d722ec73b628b363dde961 /README.md
parenta0283fa22a64f18b16ca8c57e54b1a521a4df07c (diff)
downloadneko-4e1d5662353c3d54d3edb9cfe07893bcc56e331b.tar.gz
neko-4e1d5662353c3d54d3edb9cfe07893bcc56e331b.tar.bz2
neko-4e1d5662353c3d54d3edb9cfe07893bcc56e331b.zip
update documentation with prerequisites and local dev setup
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6b36a05..e801687 100644
--- a/README.md
+++ b/README.md
@@ -307,6 +307,26 @@ The project underwent a significant modernization phase with the help of Google
# Development and Testing
+## Local Development Setup
+
+To contribute to Neko or run the full test suite locally, you will need the following tools:
+
+- **Go (1.24+)**: For backend development and running tests.
+- **Node.js (20+) & npm**: For frontend development and building UI assets.
+- **Docker**: For containerized development and verifying the Docker build.
+- **SQLite3**: For direct database manipulation and debugging.
+- **Pandoc**: Required for `make docs` to generate `readme.html`.
+- **golangci-lint**: Required for `make lint` to run static analysis.
+
+### Quick Start for Developers
+
+```bash
+make all # Clean, rebuild UIs, build binary, and generate docs
+make test # Run all backend and frontend tests
+make check # Run linting and tests
+```
+
+
## Development with Containers
If you don't have Go or Node installed locally, or prefer an isolated environment, you can use the provided `docker-compose.dev.yaml`.