Skip to content

docs: add PROJECT_SUMMARY.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add PROJECT_SUMMARY.md #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions PROJECT_SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# always-on-ai-assistant — Project Summary

- Upstream: [disler/always-on-ai-assistant](https://github.com/disler/always-on-ai-assistant)
- Stars (upstream): 935
- Description: A pattern for an always on AI Assistant powered by Deepseek-V3, RealtimeSTT, and Typer for engineering
- Primary Languages: Python (19)
- Detected Stack: Python, Python

## Tooling
- Minimal tooling detected

## Build
- Python: Packaging: project metadata present

## Common Commands
- No Node scripts detected

## Project Layout (top-level)
- ai_docs
- commands
- images
- modules
- prompts
- tests
- .env.sample
- .gitignore
- .python-version
- .template.aider.conf.yml
- ada.sh
- assistant_config.yml

## CI/CD
- No CI workflows detected

## Docker
- No Docker artifacts detected

## Quickstart
```
python -m venv .venv ; . .venv/Scripts/Activate.ps1
pip install -U ruff black mypy pytest
pytest -q
```

## Suggested Next Steps
- Add .editorconfig
- Add GitHub Actions CI (lint, type, test)
- Add Ruff/Black/Mypy via pyproject.toml
- Add Dockerfile for containerized runs