docs: add project README
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
# AI For Dummies
|
||||
|
||||
A lightweight, presentation-style field guide to AI-assisted engineering.
|
||||
|
||||
It explains how to combine a strong planning/review model with faster workers,
|
||||
reusable skills, subagent handoffs, Git worktrees, and explicit verification.
|
||||
|
||||
## Run locally
|
||||
|
||||
This is a dependency-free static site:
|
||||
|
||||
```bash
|
||||
python3 -m http.server 4173
|
||||
```
|
||||
|
||||
Then open <http://localhost:4173>.
|
||||
|
||||
Verify the content and interaction contracts with:
|
||||
|
||||
```bash
|
||||
npm run verify
|
||||
```
|
||||
|
||||
## Project structure
|
||||
|
||||
- `index.html` — presentation content and semantic structure
|
||||
- `styles.css` — editorial visual system and responsive layout
|
||||
- `app.js` — small workflow-phase interaction
|
||||
- `docs/references/` — bundled research sources and notes
|
||||
- `GATES.md` — acceptance ledger for the project
|
||||
|
||||
## Publishing
|
||||
|
||||
The Gitea instance has a Pages Server configured to publish a repository’s
|
||||
`pages` branch under `pages.marcospaulo.dev.br`. The intended site address is:
|
||||
|
||||
<https://ai-for-dummies.netcracker.pages.marcospaulo.dev.br>
|
||||
|
||||
If the URL is not available yet, verify that the `pages` branch exists and that
|
||||
the repository’s Gitea Actions workflow has completed. Gitea itself does not
|
||||
provide a built-in Pages server; this setup uses the instance’s separate Pages
|
||||
Server and Actions deployment path.
|
||||
|
||||
## Research
|
||||
|
||||
See [docs/references/README.md](docs/references/README.md) for official Claude,
|
||||
Codex, and Git documentation plus agent-workflow research.
|
||||
Reference in New Issue
Block a user