File tree Expand file tree Collapse file tree 2 files changed +37
-7
lines changed
Expand file tree Collapse file tree 2 files changed +37
-7
lines changed Original file line number Diff line number Diff line change @@ -19,6 +19,22 @@ AI-assisted development patterns. Each pattern is standalone - adopt what you ne
1919
2020See [ Quickstart] ( docs/quickstart.md ) for pattern overview and adoption guidance.
2121
22+ ## Development Setup
23+
24+ ``` bash
25+ git clone https://github.com/ambient-code/reference.git
26+ cd reference
27+ ./scripts/setup.sh
28+ source .venv/bin/activate
29+ pre-commit install
30+ ```
31+
32+ ** Prerequisites** : Python 3.11+, Node.js (for markdownlint and mermaid-cli)
33+
34+ ``` bash
35+ npm install -g markdownlint-cli @mermaid-js/mermaid-cli
36+ ```
37+
2238## Repository Contents
2339
2440``` text
Original file line number Diff line number Diff line change 2727echo " Installing documentation dependencies..."
2828uv pip install -r requirements-dev.txt
2929
30- # Verify installation
31- echo " Verifying installation ..."
32- echo " ✓ Documentation tooling installed "
30+ # Install pre-commit hooks
31+ echo " Installing pre-commit hooks ..."
32+ .venv/bin/pre-commit install
3333
34+ # Check for npm tools
3435echo " "
35- echo " Setup complete! 🎉"
36+ echo " Checking npm tools..."
37+ if command -v markdownlint & > /dev/null; then
38+ echo " ✓ markdownlint installed"
39+ else
40+ echo " ⚠ markdownlint not found - install with: npm install -g markdownlint-cli"
41+ fi
42+
43+ if command -v mmdc & > /dev/null; then
44+ echo " ✓ mermaid-cli installed"
45+ else
46+ echo " ⚠ mermaid-cli not found - install with: npm install -g @mermaid-js/mermaid-cli"
47+ fi
48+
49+ echo " "
50+ echo " Setup complete!"
3651echo " "
3752echo " Next steps:"
3853echo " 1. Activate virtual environment: source .venv/bin/activate"
39- echo " 2. Explore documentation: cat docs/quickstart.md"
40- echo " 3. Validate Mermaid diagrams: ./scripts/validate-mermaid.sh"
41- echo " 4. Lint markdown: markdownlint docs/**/*.md --fix"
54+ echo " 2. Install npm tools (if missing): npm install -g markdownlint-cli @mermaid-js/mermaid-cli"
55+ echo " 3. Validate docs: pre-commit run --all-files"
4256echo " "
4357echo " For a working application demo, see:"
4458echo " https://github.com/ambient-code/demo-fastapi"
You can’t perform that action at this time.
0 commit comments