diff options
| author | Paul Buetow <paul@buetow.org> | 2025-07-22 15:14:08 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-07-22 15:14:08 +0300 |
| commit | aeb772bccd3d29ed5e9d93229af1ea7d158e00d5 (patch) | |
| tree | d45c0c31a73bd62fe97c663011caae5e1cdb2cf6 /AGENTS.md | |
| parent | a9c82dc7ec525358c3ff417f32f116f760b92a65 (diff) | |
Reorganize assets and bump version to 0.7.3v0.7.3
- Move totalrecall.desktop, install-icon.sh, and config.yaml.example to assets/ directory
- Update all references in README.md and install-icon.sh
- Add file organization guidelines to AGENTS.md
- Clean up root directory structure
π€ Generated with [opencode](https://opencode.ai)
Co-Authored-By: opencode <noreply@opencode.ai>
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 16 |
1 files changed, 15 insertions, 1 deletions
@@ -58,13 +58,18 @@ golangci-lint run ### Package Structure ``` totalrecall/ -βββ cmd/totalrecall/ # CLI entry point +βββ cmd/totalrecall/ # CLI entry point βββ internal/ # Private packages β βββ audio/ # Audio generation (OpenAI TTS) β βββ image/ # Image generation functionality β βββ anki/ # Anki format generation β βββ config/ # Configuration management β βββ version.go # Version information +βββ assets/ # Static assets and configuration +β βββ icons/ # Application icons +β βββ config.yaml.example # Example configuration +β βββ totalrecall.desktop # Desktop entry file +β βββ install-icon.sh # Icon installation script ``` ### Key Design Decisions @@ -102,3 +107,12 @@ package main // NOT package bulg - Input should be in Cyrillic script - Common test words: ΡΠ±ΡΠ»ΠΊΠ° (apple), ΠΊΠΎΡΠΊΠ° (cat), ΠΊΡΡΠ΅ (dog) - OpenAI voices: nova, alloy, echo, shimmer (work well for Bulgarian) + +## Code Guidelines +- Whenever updating code, also update the comments in the code to reflect the reality and the reasoning. +- When a function reaches 50 lines of code or more, try to refactor it into several functions of about 30 lines each. In case of a go project, when main.go becomes too large, move code into the ./internal package. + +## File Organization +- Configuration examples, desktop files, and installation scripts should be placed in the `assets/` directory +- Icons and images go in `assets/icons/` +- Keep the root directory clean by moving non-essential files to appropriate subdirectories |
