Skip to content

Commit 731575a

Browse files
committed
update README.md
1 parent 38e8656 commit 731575a

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ AgentKit is an enterprise-level AI Agent development platform launched by Volcen
2929
This repository contains a collection of examples and tutorials to help you understand, implement, and integrate AgentKit functionalities into your applications.
3030

3131
## Project Structure
32+
3233
```bash
3334
.
3435
├── 01-tutorials
@@ -49,6 +50,7 @@ This repository contains a collection of examples and tutorials to help you unde
4950
│ │ └── README.md
5051
│ ├── customer_support
5152
│ └── video_gen
53+
├── template/ # Template project for AgentKit samples
5254
├── README.md
5355
└── README.zh.md
5456
```
@@ -99,7 +101,7 @@ All examples require you to first install the AgentKit SDK [Installation Referen
99101

100102
Each example follows the standard AgentKit application structure:
101103

102-
```
104+
```text
103105
Example Directory/
104106
├── agent.py # Agent main program
105107
├── requirements.txt # Dependency list
@@ -120,12 +122,10 @@ We welcome community contributions! If you have new examples or improvement sugg
120122

121123
1. Fork this repository
122124
2. Create a feature branch (`git checkout -b feature/amazing-example`)
123-
3. Commit your changes (`git commit -m 'Add amazing example'`)
124-
4. Push to the branch (`git push origin feature/amazing-example`)
125-
5. Create a Pull Request
126-
127-
## License
128-
This project is licensed under the [Apache 2.0 License](./LICENSE)
125+
3. **Copy the template directory**: Copy the `template/` directory as your new example directory, and rename it to your example name
126+
4. Commit your changes (`git commit -m 'Add amazing example'`)
127+
5. Push to the branch (`git push origin feature/amazing-example`)
128+
6. Create a Pull Request
129129

130130
## Support & Feedback
131131

@@ -138,6 +138,10 @@ This project is licensed under the [Apache 2.0 License](./LICENSE)
138138
- [AgentKit SDK/CLI Documentation](https://volcengine.github.io/agentkit-sdk-python/)
139139
- [veadk Official Documentation](https://volcengine.github.io/veadk-python/)
140140

141+
## License
142+
143+
This project is licensed under the [Apache 2.0 License](./LICENSE)
144+
141145
---
142146

143-
**Start exploring the powerful capabilities of AgentKit! Choose an example that interests you, follow the tutorials, and build your own agent applications.**
147+
**Start exploring the powerful capabilities of AgentKit! Choose an example that interests you, follow the tutorials, and build your own agent applications.**

0 commit comments

Comments
 (0)