Skip to content

Commit de16534

Browse files
committed
feat(docs): generate generic boilerplate in install.sh
1 parent b7d6eea commit de16534

File tree

2 files changed

+90
-6
lines changed

2 files changed

+90
-6
lines changed

docs/install.sh

Lines changed: 89 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,90 @@ confirm() {
3232
fi
3333
}
3434

35+
create_readme_boilerplate() {
36+
cat <<EOF > README.md
37+
# Project Name
38+
39+
Brief description of the project.
40+
41+
## 🚀 Quick Start
42+
43+
1. Install dependencies.
44+
2. Run the application.
45+
46+
## 🛠️ Built With
47+
48+
- [Gemini CLI](https://github.com/apiad/gemini-cli) - AI-powered development framework.
49+
50+
## 📄 License
51+
52+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
53+
EOF
54+
}
55+
56+
create_changelog_boilerplate() {
57+
cat <<EOF > CHANGELOG.md
58+
# Changelog
59+
60+
All notable changes to this project will be documented in this file.
61+
62+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
63+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
64+
65+
## [Unreleased]
66+
67+
### Added
68+
- Initial project setup with Gemini CLI framework.
69+
EOF
70+
}
71+
72+
create_tasks_boilerplate() {
73+
cat <<EOF > TASKS.md
74+
# Tasks
75+
76+
Legend:
77+
78+
- [ ] Todo
79+
- [/] In Progress (@user)
80+
- [x] Done
81+
82+
**INSTRUCTIONS:**
83+
84+
Keep task descriptions short but descriptive. Do not add implementation details, those belong in task-specific plans.
85+
86+
---
87+
88+
## Active Tasks
89+
90+
- [ ] Define project requirements and initial roadmap.
91+
92+
---
93+
94+
## Archive
95+
EOF
96+
}
97+
98+
create_makefile_boilerplate() {
99+
cat <<EOF > makefile
100+
.PHONY: all test lint format
101+
102+
all: test lint
103+
104+
test:
105+
@echo "Running tests..."
106+
107+
lint:
108+
@echo "Running linting..."
109+
110+
format:
111+
@echo "Running formatting..."
112+
113+
install-hooks:
114+
ln -sf ../../.gemini/hooks/pre-commit.py .git/hooks/pre-commit
115+
chmod +x .git/hooks/pre-commit
116+
EOF
117+
}
118+
35119
# --- Check Prerequisites ---
36120
for cmd in git node; do
37121
if ! command -v "$cmd" >/dev/null 2>&1; then
@@ -175,12 +259,11 @@ for f in "${CORE_FILES[@]}"; do
175259
fi
176260
done
177261

178-
# 3. Create Scaffolding Files (Only if missing)
179-
for f in "${SCAFFOLD_FILES[@]}"; do
180-
if [[ ! -f "$f" ]]; then
181-
cp "$TEMP_DIR/$f" .
182-
fi
183-
done
262+
# 3. Create Scaffolding Files (Boilerplate if missing)
263+
if [[ ! -f "README.md" ]]; then create_readme_boilerplate; fi
264+
if [[ ! -f "CHANGELOG.md" ]]; then create_changelog_boilerplate; fi
265+
if [[ ! -f "TASKS.md" ]]; then create_tasks_boilerplate; fi
266+
if [[ ! -f "makefile" ]]; then create_makefile_boilerplate; fi
184267

185268
# 4. Ensure Content Directories & .gitkeep
186269
for d in "${CONTENT_DIRS[@]}"; do

journal/2026-03-20.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@
1212
[2026-03-20T08:46:18] - chore(release): version 0.17.1
1313
[2026-03-20T09:54:08] - docs: update comprehensive documentation suite (index, deploy, design, develop, user-guide) with latest framework improvements
1414
[2026-03-20T10:01:39] - docs: update /debug and /task workflows with scientific investigation and TCR details
15+
[2026-03-20T10:19:25] - feat(docs): update install.sh to generate generic boilerplate for scaffolding files

0 commit comments

Comments
 (0)