Update: README clarifies two-step project creation

- Step 1: Create repo on Gitea web UI first
- Step 2: Run init-project to set up local copy
- Emphasize SSH authentication for git push
- Update workflow summary with correct order
- Clarify agents use SSH remote
This commit is contained in:
root
2025-11-23 22:29:22 +00:00
parent d537ddc665
commit d289d33c4d

View File

@@ -22,7 +22,7 @@ This sets up everything you need. See [QUICK-START.md](QUICK-START.md) for detai
- **sysadmin-session-closer** - Automatically closes and documents dev sessions
- Use at end of sessions to commit and push work
- Generates comprehensive session summaries
- Handles git workflows automatically
- Handles git workflows automatically via SSH
## Usage
@@ -34,6 +34,12 @@ source <(curl -s http://100.120.125.113:3000/pdm/homelab-agents/raw/branch/main/
### Create a New Project
**Step 1: Create repository on Gitea**
Go to http://100.120.125.113:3000/repo/create
- Repository name: `my-project`
- Click Create
**Step 2: Initialize project locally**
```bash
init-project my-project
cd my-project
@@ -41,7 +47,7 @@ cd my-project
```
Each project automatically gets:
- Git repo with Gitea remote configured
- Git repo with SSH remote configured (git@100.120.125.113:pdm/my-project.git)
- Agents available at `.claude/agents/`
- Git user info set up
@@ -55,12 +61,13 @@ Use the summary agent from your project:
The agent will:
- Create comprehensive session summary
- Commit all changes
- Push to Gitea automatically
- Push to Gitea via SSH automatically
## Documentation
- [QUICK-START.md](QUICK-START.md) - Fast setup guide for new VPS instances
- [scripts/README.md](scripts/README.md) - Documentation for helper scripts
- [SSH-SETUP.md](SSH-SETUP.md) - SSH key configuration for git push
- [agents/README.md](agents/README.md) - Information about available agents
## Repository Information
@@ -68,3 +75,12 @@ The agent will:
- **Location**: http://100.120.125.113:3000/pdm/homelab-agents
- **Access**: Internal network only
- **Purpose**: Centralized AI agent prompts for all homelab VPS instances
## Workflow Summary
1. Bootstrap VPS: `source <(curl -s ...bootstrap-agents.sh)`
2. Create repo on Gitea: http://100.120.125.113:3000/repo/create
3. Init project: `init-project my-project`
4. Work on project
5. Close session with agent
6. Agent auto-commits and pushes via SSH