Skip to content

Commit 1a29b80

Browse files
committed
docs: improved readme
1 parent e60eb59 commit 1a29b80

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,29 @@
1111

1212
*A cognitive partnership model that enforces rigorous engineering standards, strategic planning, and continuous validation.*
1313

14+
#### πŸš€ [**Check out the launch blog post!**](https://blog.apiad.net/p/how-im-using-ai-today)
15+
1416
</div>
1517

1618
---
1719

18-
## 🧠 The Core Philosophy: AI as a Senior Partner
20+
## πŸ”₯ Quick Start
21+
22+
This repository is meant to be used as a template for new projects.
23+
24+
1. Clone the repo or [create a new project directly](https://github.com/apiad/starter/generate).
25+
2. Delete `README.md`, `CHANGELOG.md`, and `journal/*.md` to get a fresh history.
26+
3. Run `gemini /scaffold` to start a new project.
27+
4. Follow instructions and enjoy!
1928

20-
In this framework, the AI agent is not just a "code generator" or a "copilot". It is a **Senior Architect and Critical Thinking Partner**.
29+
## 🧠 The Core Philosophy
30+
31+
This repository is a heavily customized and oppinionanted Gemini CLI agent, ready to be used in any situation. In this framework, the AI agent is not just a "code generator" or a "copilot". It is a **Senior Architect and Critical Thinking Partner**:
2132

2233
* **πŸ›‘οΈ Critical Feedback First:** The agent is instructed to challenge unsafe, redundant, or poorly conceived ideas *before* writing a single line of code.
2334
* **πŸ“‹ Research -> Plan -> Execute:** Every non-trivial change follows a strict lifecycle. The agent first researches context, proposes a detailed plan, waits for your explicit approval, and only then begins implementation.
2435
* **βœ… Validation-Always:** The framework uses `make` as a source of truth. The agent is hooked into the `makefile` to ensure every change is validated (linted and tested) before being finalized.
2536

26-
---
27-
2837
## πŸ› οΈ The Project Lifecycle
2938

3039
The `.gemini/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
@@ -54,9 +63,7 @@ The `.gemini/commands/` directory defines specialized workflows that automate ev
5463
* **`/commit`**: Analyzes all uncommitted changes, groups them into logical features or fixes, and guides you through committing them individually using **Conventional Commits**.
5564
* **`/release`**: Automates the final shipping steps: running tests, determining the next version (semver), updating the `CHANGELOG.md`, and tagging the release.
5665

57-
---
58-
59-
## πŸ”„ Standard Operating Procedures (SOPs)
66+
## πŸ”„ Common Use Cases
6067

6168
This framework shines when you combine these commands into cohesive workflows:
6269

@@ -79,9 +86,7 @@ This framework shines when you combine these commands into cohesive workflows:
7986
2. **Draft:** Run `/draft` to build an outline and expand it into a full article.
8087
3. **Revise:** Use `/revise` for step-by-step style guide-driven audits and refinements.
8188

82-
---
83-
84-
## βš“ The Hook System: Staying in Sync
89+
## βš“ The Hook System
8590

8691
The framework uses a robust hook system (`.gemini/hooks/`) that synchronizes the agent with your project state:
8792

@@ -90,8 +95,6 @@ The framework uses a robust hook system (`.gemini/hooks/`) that synchronizes the
9095
* **`make.py`**: Automatically runs `make` after critical agent actions to prevent regressions.
9196
* **`cron.py`**: Synchronizes `cron.toml` tasks with **systemd user timers**.
9297

93-
---
94-
95-
## πŸ“„ License
98+
## πŸ“„ License & Contribution
9699

97-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
100+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. All contributions are welcome!

0 commit comments

Comments
Β (0)