|
19 | 19 |
|
20 | 20 | ## 🔥 Quick Start |
21 | 21 |
|
22 | | -The fastest way to bootstrap a new project from this template is to run the following command in your terminal: |
| 22 | +The fastest way to bootstrap a new project or integrate the framework into an existing one is to run the following command in your terminal: |
23 | 23 |
|
24 | 24 | ```bash |
25 | 25 | curl -fsSL https://raw.githubusercontent.com/apiad/starter/main/install.sh | bash |
26 | 26 | ``` |
27 | 27 |
|
28 | 28 | This interactive script will: |
29 | | -1. **Prompt** for your project name and target directory. |
30 | | -2. **Clone** the template and **reset** the Git history. |
31 | | -3. **Clean** out placeholder content (`README.md`, `CHANGELOG.md`, `journal/`, etc.). |
32 | | -4. **Initialize** a fresh project structure, ready for the Gemini CLI. |
33 | | -5. **Launch** the Gemini CLI to start your first session. |
| 29 | +1. **Validate** your environment (requires `git`, `node`, and a clean working tree). |
| 30 | +2. **Clone** the latest framework components to a temporary location. |
| 31 | +3. **Analyze** your current directory and propose a list of files to create or update. |
| 32 | +4. **Prompt** for your explicit confirmation before applying any changes. |
| 33 | +5. **Integrate** the `.gemini/` configuration and framework files (non-destructively). |
| 34 | +6. **Commit** the changes automatically with a descriptive message. |
34 | 35 |
|
35 | | -Once Gemini CLI is open, run `/scaffold` to begin, or `/onboard` to get an overview of the repository. |
| 36 | +Once the installation is complete, run `gemini /onboard` to get an overview of the repository and start your first session. |
36 | 37 |
|
37 | | -### 📥 Integration (Existing Projects) |
38 | | - |
39 | | -To add this framework to an existing Git repository, run: |
40 | | - |
41 | | -```bash |
42 | | -curl -fsSL https://raw.githubusercontent.com/apiad/starter/main/add-gemini.sh | bash |
43 | | -``` |
44 | | - |
45 | | -This script will: |
46 | | -1. **Check** for a clean working tree. |
47 | | -2. **Prompt** for permission before overwriting any existing core files. |
48 | | -3. **Extract** the `.gemini/` configuration and framework files. |
49 | | -4. **Create** a first integration commit. |
50 | | - |
51 | | -### 🏗️ Alternative Installation |
| 38 | +### 🏗️ Alternative: Manual Setup |
52 | 39 |
|
53 | 40 | If you prefer a manual setup: |
54 | 41 |
|
55 | | -1. Clone the repo or [create a new project directly](https://github.com/apiad/starter/generate). |
56 | | -2. Delete `README.md`, `CHANGELOG.md`, and `journal/*.md` to get a fresh history. |
57 | | -3. Run `gemini /scaffold` to start a new project. |
| 42 | +1. [Create a new project from this template](https://github.com/apiad/starter/generate). |
| 43 | +2. Follow the onboarding instructions in the generated repository. |
58 | 44 |
|
59 | 45 | --- |
60 | 46 |
|
|
0 commit comments