Tweaked the README.md
Browse files
README.md
CHANGED
|
@@ -149,7 +149,7 @@ Create custom profiles with dedicated instructions and enabled tools!
|
|
| 149 |
|
| 150 |
Set `REACHY_MINI_CUSTOM_PROFILE=<name>` to load `src/reachy_mini_conversation_app/profiles/<name>/` (see `.env.example`). If unset, the `default` profile is used.
|
| 151 |
|
| 152 |
-
Each profile
|
| 153 |
|
| 154 |
### Custom instructions
|
| 155 |
Write plain-text prompts in `instructions.txt`. To reuse shared prompt pieces, add lines like:
|
|
@@ -169,7 +169,11 @@ play_emotion
|
|
| 169 |
# My custom tool defined locally
|
| 170 |
sweep_look
|
| 171 |
```
|
| 172 |
-
Tools are resolved first from Python files in the profile folder, then from the shared library `src/reachy_mini_conversation_app/tools/` (e.g., `dance`, `head_tracking`).
|
|
|
|
|
|
|
|
|
|
|
|
|
| 173 |
|
| 174 |
|
| 175 |
|
|
|
|
| 149 |
|
| 150 |
Set `REACHY_MINI_CUSTOM_PROFILE=<name>` to load `src/reachy_mini_conversation_app/profiles/<name>/` (see `.env.example`). If unset, the `default` profile is used.
|
| 151 |
|
| 152 |
+
Each profile requires two files: `instructions.txt` (prompt text) and `tools.txt` (list of allowed tools), and optionally contains custom tools implementations.
|
| 153 |
|
| 154 |
### Custom instructions
|
| 155 |
Write plain-text prompts in `instructions.txt`. To reuse shared prompt pieces, add lines like:
|
|
|
|
| 169 |
# My custom tool defined locally
|
| 170 |
sweep_look
|
| 171 |
```
|
| 172 |
+
Tools are resolved first from Python files in the profile folder (custom tools), then from the shared library `src/reachy_mini_conversation_app/tools/` (e.g., `dance`, `head_tracking`).
|
| 173 |
+
|
| 174 |
+
### Custom tools
|
| 175 |
+
On top of built-in tools found in the shared library, you can implement custom tools specific to your profile by adding Python files in the profile folder.
|
| 176 |
+
Custom tools must subclass `reachy_mini_conversation_app.tools.core_tools.Tool` (see `profiles/example/sweep_look.py`).
|
| 177 |
|
| 178 |
|
| 179 |
|