Skip to content

Commit 673085e

Browse files
committed
Chore: Reorder README sections
The "Make targets" and "Quick start" sections have been moved to appear before the "Examples" section in the README. This improves the logical flow of the documentation, presenting setup and usage instructions before specific examples.
1 parent 70061e8 commit 673085e

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,6 @@
22

33
A tiny, KISS-friendly command line agent that can talk to either OpenAI's ChatGPT API or Google's Gemini API. The agent supports a pluggable backend, a light tool loop, and environment-driven configuration.
44

5-
### Make targets (uvx-powered)
6-
7-
The repo ships with a lightweight `Makefile` wired to [`uvx`](https://docs.astral.sh/uv/guides/tools/) for reproducible tooling:
8-
9-
- `make venv` – create a local virtual environment at `env/` (activate with `source env/bin/activate`).
10-
- `make install` – install dependencies (uses `env/bin/python` if `make venv` ran, otherwise falls back to `uvx python`).
11-
- `make run PROMPT="hello"` – run the agent with the provided prompt.
12-
- `make tools` – list the currently wired tools.
13-
- `make lint` – run Ruff via `uvx` (no local install required).
14-
15-
### Quick start
16-
17-
1. Create a virtual environment for Python 3.11+ and install the dependencies:
18-
```bash
19-
make install
20-
```
21-
2. Copy `.env.example` to `.env` and fill in the API keys you plan to use.
22-
3. Run the agent:
23-
```bash
24-
make run PROMPT="Summarize the latest message."
25-
```
26-
275
### Examples
286

297
#### Disk space:
@@ -59,6 +37,29 @@ Warsaw
5937
Today's Featured Article on Wikipedia is "U2 in 2005".
6038
```
6139
40+
41+
### Make targets (uvx-powered)
42+
43+
The repo ships with a lightweight `Makefile` wired to [`uvx`](https://docs.astral.sh/uv/guides/tools/) for reproducible tooling:
44+
45+
- `make venv` – create a local virtual environment at `env/` (activate with `source env/bin/activate`).
46+
- `make install` – install dependencies (uses `env/bin/python` if `make venv` ran, otherwise falls back to `uvx python`).
47+
- `make run PROMPT="hello"` – run the agent with the provided prompt.
48+
- `make tools` – list the currently wired tools.
49+
- `make lint` – run Ruff via `uvx` (no local install required).
50+
51+
### Quick start
52+
53+
1. Create a virtual environment for Python 3.11+ and install the dependencies:
54+
```bash
55+
make install
56+
```
57+
2. Copy `.env.example` to `.env` and fill in the API keys you plan to use.
58+
3. Run the agent:
59+
```bash
60+
make run PROMPT="Summarize the latest message."
61+
```
62+
6263
### Configuration
6364
6465
All settings live in `.env` (loaded with `python-dotenv`):

0 commit comments

Comments
 (0)