diff --git a/AGENTS.md b/AGENTS.md index 2125d84b..aa87fb49 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,33 +1,16 @@ # AGENTS.md -These are instructions and rules for the LLM model when answering a prompt. +## Project structure -## Taskfile - -This project uses the standard. - -Always try to run a command with the `./task` file script. - -The `./task` file is a bash script that provides all functions necessary to work with this project. - -## Commands - -The `./task.md` provides an overview of the available task commands. - -If necessary lookup the command function in the `./task` file. - -## Templates - -The `./templates` folder contains template files to new modules and modifications. - -## Docker - -If you use Docker to run Odoo ensure that the `ODOO_ADDONS_PATH` in the `.env` file is correct. - -## Avoid - -Avoid looking into the `./odoo` and `./enterprise` folders. Only check the folder structure. - -## Ignore - -Ignore content of `./modules.md`. +- `task`: The main entry point. It manages the entire project. +- `addons/`: +- `bin/`: Contains helper scripts for the task file. +- `enterprise/`: Here is the Odoo enterprise source code. +- `images/`: This folder contains the build files for multiple Docker images. + - `odoo/`: This is the main image. +- `odoo/`: Here is the Odoo enterprise source code. +- `revisions/`: Generated Odoo revision files. +- `snippets/`: Big folder with XML-edit files. Ignore. +- `templates/`: Templates for Odoo modules and git repos. +- `themes/`: Official Odoo website themes. +- `thirdparty/`: Thirdparty Odoo modules.