Skip to content

Commit d8e3b2c

Browse files
committed
Update README.md for improved command options and testing instructions
1 parent 13c8f40 commit d8e3b2c

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ pdm run compendium create "Lithium-ion battery recycling"
5656
```
5757

5858
**Options:**
59+
5960
- `--output PATH` — Base path/filename for the output (extension is ignored).
6061
- `--no-background` — Force synchronous execution (useful for short or restricted queries).
6162
- `--max-tool-calls N` — Cap the total number of tool calls for cost control.
@@ -74,6 +75,7 @@ pdm run compendium render my-topic.xml --format html
7475
```
7576

7677
**Options:**
78+
7779
- `--format FORMAT` — Output format(s) to generate (`md`, `xml`, `html`, `pdf`, `skill`).
7880
- `--output PATH` — Base path/filename for the output.
7981

@@ -86,6 +88,7 @@ pdm run compendium recover
8688
```
8789

8890
**Options:**
91+
8992
- `--input PATH` — Path to the recovery JSON file (defaults to `timed_out_research.json`).
9093

9194
---
@@ -175,8 +178,8 @@ This format is intentionally verbose to support downstream transformation. Markd
175178

176179
## Testing & Quality
177180

178-
- `pdm run pytest` — Executes the unit suite. Tests stub the OpenAI client, so they run offline.
179-
- `pdm run flake8 src tests` — Linting.
181+
- `pdm run test` — Executes the unit suite. Tests stub the OpenAI client, so they run offline.
182+
- `pdm run lint` — Linting.
180183
- `pdm build` — Produce distributable artifacts.
181184

182185
If `pdm` fails to write log files in restricted environments, set `PDM_HOME` to a writable directory (for example, `export PDM_HOME=.pdm_home`).
@@ -188,14 +191,8 @@ If `pdm` fails to write log files in restricted environments, set `PDM_HOME` to
188191
1. Fork and clone the repository.
189192
2. Run `pdm install --group dev`.
190193
3. Make changes following the style guide and update/add tests.
191-
4. Run `pdm run pytest` and `pdm run flake8 src tests`.
194+
4. Run `pdm run test` and `pdm run lint`.
192195
5. Raise a pull request with:
193196
- A concise description of the change.
194197
- Verification commands executed locally.
195198
- Representative XML samples if the user-facing structure changes.
196-
197-
---
198-
199-
## License
200-
201-
MIT © B.T. Franklin and contributors.

0 commit comments

Comments
 (0)