RemiFabre commited on
Commit
aa234e2
·
1 Parent(s): 361a12c

README iteration

Browse files
Files changed (1) hide show
  1. README.md +5 -15
README.md CHANGED
@@ -145,11 +145,11 @@ By default, the app runs in console mode for direct audio interaction. Use the `
145
  | `do_nothing` | Explicitly remain idle. | Core install only. |
146
 
147
  ## Using custom profiles
148
- You can create and run custom profiles with their dedicated instructions in the prompt, and a custom set of enabled tools.
149
 
150
- Set `REACHY_MINI_CUSTOM_PROFILE=<name>` to load a profile from `src/reachy_mini_conversation_app/profiles/<name>/` (see .env.example). If the variable is not set, the `default` profile is used.
151
 
152
- Each profile needs two files: `instructions.txt` (prompt text) and `tools.txt` (list of tools allowed).
153
 
154
  ### Custom instructions
155
  Write plain-text prompts in `instructions.txt`. To reuse shared prompt pieces, add lines like:
@@ -157,9 +157,7 @@ Write plain-text prompts in `instructions.txt`. To reuse shared prompt pieces, a
157
  [passion_for_lobster_jokes]
158
  [identities/witty_identity]
159
  ```
160
- See `src/reachy_mini_conversation_app/profiles/example/` for a reference layout.
161
-
162
- Each placeholder pulls the content of the matching file under `src/reachy_mini_conversation_app/prompts/` (nested paths allowed).
163
 
164
  ### Enabling tools
165
  List enabled tools in `tools.txt`, one per line; prefix with `#` to comment out. For example:
@@ -171,15 +169,7 @@ play_emotion
171
  # My custom tool defined locally
172
  sweep_look
173
  ```
174
- Tools will be searched for in the shared tools library located in `src/reachy_mini_conversation_app/tools/` as well as in the profile folder (the later is searched for first).
175
-
176
-
177
- ### Local custom tools
178
- You can define custom tools by creating a Python file directly in the profile folder.
179
-
180
- Custom Python tools must subclass `reachy_mini_conversation_app.tools.core_tools.Tool` (see `profiles/example/sweep_look.py` and `throw_stone.py`).
181
-
182
- then shared tools in `src/reachy_mini_conversation_app/tools/` (e.g., `dance`, `head_tracking`). Custom Python tools must subclass `reachy_mini_conversation_app.tools.core_tools.Tool` (see `profiles/example/sweep_look.py` and `throw_stone.py`).
183
 
184
 
185
 
 
145
  | `do_nothing` | Explicitly remain idle. | Core install only. |
146
 
147
  ## Using custom profiles
148
+ 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 needs two files: `instructions.txt` (prompt text) and `tools.txt` (list of allowed tools).
153
 
154
  ### Custom instructions
155
  Write plain-text prompts in `instructions.txt`. To reuse shared prompt pieces, add lines like:
 
157
  [passion_for_lobster_jokes]
158
  [identities/witty_identity]
159
  ```
160
+ Each placeholder pulls the matching file under `src/reachy_mini_conversation_app/prompts/` (nested paths allowed). See `src/reachy_mini_conversation_app/profiles/example/` for a reference layout.
 
 
161
 
162
  ### Enabling tools
163
  List enabled tools in `tools.txt`, one per line; prefix with `#` to comment out. For example:
 
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`). Custom tools must subclass `reachy_mini_conversation_app.tools.core_tools.Tool` (see `profiles/example/sweep_look.py` and `throw_stone.py`).
 
 
 
 
 
 
 
 
173
 
174
 
175