summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-07-22 15:14:08 +0300
committerPaul Buetow <paul@buetow.org>2025-07-22 15:14:08 +0300
commitaeb772bccd3d29ed5e9d93229af1ea7d158e00d5 (patch)
treed45c0c31a73bd62fe97c663011caae5e1cdb2cf6 /AGENTS.md
parenta9c82dc7ec525358c3ff417f32f116f760b92a65 (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.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 6ed9514..13d65cf 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -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