mirror of
https://github.com/DeusData/codebase-memory-mcp.git
synced 2026-11-04 10:48:20 +00:00
docs: fix contributor prerequisites paragraph break and lint wording
Replace the literal "\n\n" in CONTRIBUTING.md with a real paragraph
break; Markdown rendered it as text in the middle of the sentence.
A plain scripts/lint.sh run is the full mode and needs clang-tidy as
well as cppcheck and clang-format; scripts/lint.sh --ci, which is what
CI runs, skips clang-tidy. Say it that way round in README.md and
CONTRIBUTING.md.
The curl entry stays: since 6c00f96311 (#2480) Step 0y3 of
scripts/test.sh runs the setup-script contract, which downloads a
local fixture release through scripts/setup.sh with curl.
Signed-off-by: Martin Vogel <martin.vogel.tech@gmail.com>
This commit is contained in:
1 parent
28d62001fd
commit
2a7da82a04
2 files changed
+4
-2
No files matched your search
+3
-1
@@ -6,7 +6,9 @@ Contributions are welcome. This guide covers setup, testing, and PR guidelines.
|
||||
|
||||
## Build from Source
|
||||
|
||||
**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).\n\n**Contributor check prerequisites**: `scripts/test.sh` also requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`.
|
||||
**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).
|
||||
|
||||
**Contributor check prerequisites**: `scripts/test.sh` also requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck`, `clang-format`, and `clang-tidy`; `scripts/lint.sh --ci`, which is what CI runs, skips `clang-tidy`.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/DeusData/codebase-memory-mcp.git
|
||||
|
||||
@@ -415,7 +415,7 @@ You: "Install this MCP server: https://github.com/DeusData/codebase-memory-mcp"
|
||||
|
||||
</details>
|
||||
|
||||
> **Contributor checks need a few extra tools.** `scripts/test.sh` requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`.
|
||||
> **Contributor checks need a few extra tools.** `scripts/test.sh` requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck`, `clang-format`, and `clang-tidy`; `scripts/lint.sh --ci`, which is what CI runs, skips `clang-tidy`.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/DeusData/codebase-memory-mcp.git
|
||||
|
||||
Reference in new issue
Block a user