docs: establish fresh planning foundation with new features

- Update PROJECT.md: Add Android, visualizer, and avatar to v1
- Update REQUIREMENTS.md: 99 requirements across 15 phases (fresh slate)
- Add comprehensive README.md with setup, architecture, and usage
- Add PROGRESS.md for Discord forum sharing
- Add .gitignore for Python/.venv and project artifacts
- Note: All development via Claude Code/OpenCode workflow
- Note: Python deps managed via .venv virtual environment

Core value: Mai is a real collaborator, not a tool. She learns from you,
improves herself, has boundaries and opinions, and becomes more *her* over time.

v1 includes: Model interface, Safety, Resources, Memory, Conversation,
CLI, Self-Improvement, Approval, Personality, Discord, Offline, Voice
Visualization, Avatar, Android App, Device Sync.
This commit is contained in:
Mai Development
2026-01-26 23:21:40 -05:00
parent 5dc7b98abf
commit 3f41adff75
5 changed files with 715 additions and 26 deletions

64
.gitignore vendored
View File

@@ -1,18 +1,60 @@
# Python
__pycache__/
*.py[cod]
# venv
.venv/
venv/
env/
ENV/
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
# tooling
# IDE
.vscode/
.idea/
*.swp
*.swo
*~
.DS_Store
# Testing
.pytest_cache/
.ruff_cache/
.coverage
htmlcov/
# Project-specific
config.yaml
logs/
*.log
models/
cache/
.planning/STATE.md
.planning/PHASE-*-PLAN.md
# Discord
.env
.discord_token
# Android
android/app/build/
android/.gradle/
android/local.properties
# OS
.DS_Store
Thumbs.db
# generated
.planning/CONTEXTPACK.md
*.tmp
*.bak