Skip to content

Commit 7222a84

Browse files
authored
Imrpove "Getting Started" on README (#1516)
1 parent 762447a commit 7222a84

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,28 @@ Explore the [examples](examples) directory to see the SDK in action, and read ou
1919

2020
## Get started
2121

22-
1. Set up your Python environment
22+
To get started, set up your Python environment (Python 3.9 or newer required), and then install OpenAI Agents SDK package.
2323

24-
- Option A: Using venv (traditional method)
24+
### venv
2525

2626
```bash
27-
python -m venv env
28-
source env/bin/activate # On Windows: env\Scripts\activate
27+
python -m venv .venv
28+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
29+
pip install openai-agents
2930
```
3031

31-
- Option B: Using uv (recommended)
32+
For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.
3233

33-
```bash
34-
uv venv
35-
source .venv/bin/activate # On Windows: .venv\Scripts\activate
36-
```
34+
### uv
3735

38-
2. Install Agents SDK
36+
If you're familiar with [uv](https://docs.astral.sh/uv/), using the tool would be even similar:
3937

4038
```bash
41-
pip install openai-agents
39+
uv init
40+
uv add openai-agents
4241
```
4342

44-
For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.
43+
For voice support, install with the optional `voice` group: `uv add 'openai-agents[voice]'`.
4544

4645
## Hello world example
4746

0 commit comments

Comments
 (0)