aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Mathes <adam@adammathes.com>2026-02-18 13:02:22 -0800
committerAdam Mathes <adam@adammathes.com>2026-02-18 13:02:22 -0800
commita74885d269d2fddb21be5db402e70ac1a41a0e23 (patch)
tree6e26b634c459b6960b50d811573a7390ae6a510d
parenta3794d4ae13ad785aa9b695e5fe63ce001592562 (diff)
downloadneko-a74885d269d2fddb21be5db402e70ac1a41a0e23.tar.gz
neko-a74885d269d2fddb21be5db402e70ac1a41a0e23.tar.bz2
neko-a74885d269d2fddb21be5db402e70ac1a41a0e23.zip
remove pandoc and readme.html generation, update readme with local dev info
-rw-r--r--Makefile10
-rw-r--r--README.md3
2 files changed, 3 insertions, 10 deletions
diff --git a/Makefile b/Makefile
index 246d4ae..83002d8 100644
--- a/Makefile
+++ b/Makefile
@@ -2,23 +2,20 @@ SH=/bin/sh
GO=go
NPM=npm
-PANDOC=pandoc
BINARY=neko
VERSION=0.3
BUILD=`git rev-parse HEAD`
LDFLAGS=-ldflags "-X main.Version=${VERSION} -X main.Build=${BUILD}"
-.PHONY: default all clean build install test test-race test-frontend ui-check lint check ci run dev docs install-hooks cover coverage-html bench bench-short stress test-perf
+.PHONY: default all clean build install test test-race test-frontend ui-check lint check ci run dev install-hooks cover coverage-html bench bench-short stress test-perf
default: build
-all: clean ui-vanilla build docs
+all: clean ui-vanilla build
clean:
rm -f ${BINARY}
- rm -f readme.html
-
ui-vanilla:
@@ -82,7 +79,4 @@ stress:
test-perf:
cd frontend-vanilla && ${NPM} test -- --run src/perf/
-docs: readme.html
-readme.html: README.md
- ${PANDOC} README.md -o readme.html
diff --git a/README.md b/README.md
index 2305d05..13f2c9c 100644
--- a/README.md
+++ b/README.md
@@ -313,13 +313,12 @@ To contribute to Neko or run the full test suite locally, you will need the foll
- **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 all # Clean, rebuild UIs, and build binary
make test # Run all backend and frontend tests
make check # Run linting and tests
```