Skip to content

Commit 0df5eae

Browse files
Improve README Getting Started section with clearer setup instructions (#172)
- Add Python 3.10+ prerequisite with pip installation guidance - Include virtual environment setup step for dependency isolation - Clarify package installation with separate core packages and example-specific dependencies - Add comprehensive repository structure overview in Step 6 - Update table of contents to reflect new structure
1 parent d4f5637 commit 0df5eae

File tree

1 file changed

+59
-12
lines changed

1 file changed

+59
-12
lines changed

README.md

Lines changed: 59 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,68 @@ The examples in this repository are for **demonstration and educational purposes
4040

4141
- [📚 Table of Contents](#-table-of-contents)
4242
- [🏁 Getting Started](#-getting-started)
43-
- [Step 1: Install Required Packages](#step-1-install-required-packages)
44-
- [Step 2: Setup Model Provider](#step-2-setup-model-provider)
45-
- [Step 3: Build Your First Strands Agent](#step-3-build-your-first-strands-agent)
46-
- [Step 4: Getting Started with the SDK](#step-4-getting-started-with-the-sdk)
47-
- [Step 5: Explore More Samples](#step-5-explore-more-samples)
43+
- [Prerequisites](#prerequisites)
44+
- [Step 1: Create Virtual Environment](#step-1-create-virtual-environment)
45+
- [Step 2: Install Required Packages](#step-2-install-required-packages)
46+
- [Step 3: Setup Model Provider](#step-3-setup-model-provider)
47+
- [Step 4: Build Your First Strands Agent](#step-4-build-your-first-strands-agent)
48+
- [Step 5: Getting Started with the SDK](#step-5-getting-started-with-the-sdk)
49+
- [Step 6: Explore More Samples](#step-6-explore-more-samples)
4850

4951
## 🏁 Getting Started
5052

51-
### Step 1: Install Required Packages
53+
### Prerequisites
54+
55+
- **Python 3.10 or higher**
56+
57+
- **pip package manager**
58+
- Verify with: `pip --version` or `pip3 --version`
59+
- Usually comes bundled with Python 3.4+ installers from python.org
60+
- If pip is missing, install using one of these methods:
61+
```bash
62+
# Method 1 - Use Python's built-in module
63+
python -m ensurepip --upgrade
64+
65+
# Method 2 - Download and run the official installer
66+
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
67+
python get-pip.py
68+
```
69+
70+
### Step 1: Create Virtual Environment
71+
72+
```bash
73+
# Create virtual environment
74+
python -m venv venv
75+
76+
# Activate virtual environment
77+
# On macOS/Linux:
78+
source venv/bin/activate
79+
# On Windows:
80+
venv\Scripts\activate
81+
```
82+
83+
### Step 2: Install Required Packages
5284

5385
```bash
86+
# Install Strands core packages (required for all examples)
5487
pip install strands-agents
5588
pip install strands-agents-tools
5689
```
5790

58-
### Step 2: Setup Model Provider
91+
> **Additional Dependencies:** Individual examples throughout this repository may require extra packages. When working with a specific example, check for its `requirements.txt` file:
92+
> ```bash
93+
> # Navigate to the example folder you want to run
94+
> cd [example-directory]
95+
>
96+
> # Install dependencies if requirements.txt exists
97+
> pip install -r requirements.txt
98+
> ```
99+
100+
### Step 3: Setup Model Provider
59101

60102
Follow the instructions [here](https://strandsagents.com/latest/user-guide/quickstart/#model-providers) to configure your model provider and model access.
61103

62-
### Step 3: Build Your First Strands Agent
104+
### Step 4: Build Your First Strands Agent
63105

64106
```python
65107
from strands import Agent, tool
@@ -91,15 +133,20 @@ I have 4 requests:
91133
agent(message)
92134
```
93135
94-
### Step 4: Getting Started with the SDK
136+
### Step 5: Getting Started with the SDK
95137
96138
Start with the [01-tutorials](./01-tutorials/) directory.
97139
Create your [first agent](./01-tutorials/01-fundamentals/01-first-agent/) and explore notebook-based examples covering core functionalities.
98140
99-
### Step 5: Explore More Samples
141+
### Step 6: Explore the Repository
142+
143+
This repository is organized to help you progress from basics to advanced implementations:
100144
101-
Looking for inspiration?
102-
Check out more examples in the [02-samples](./02-samples/) folder for real-world use cases.
145+
- **[01-tutorials](./01-tutorials/)** - Step-by-step guides covering fundamentals, deployment, and best practices
146+
- **[02-samples](./02-samples/)** - Real-world use cases and industry-specific examples
147+
- **[03-integrations](./03-integrations/)** - Integration examples with AWS services and third-party tools
148+
- **[04-UX-demos](./04-UX-demos/)** - Full-stack applications with user interfaces
149+
- **[05-agentic-rag](./05-agentic-rag/)** - Advanced Agentic RAG patterns
103150
104151
## Contributing ❤️
105152

0 commit comments

Comments
 (0)