Skip to content

Commit ddc65a5

Browse files
hannesrudolphhannesrudolph
committed
docs: overhaul README for clarity and impact
1 parent 1b4819c commit ddc65a5

File tree

1 file changed

+56
-99
lines changed

1 file changed

+56
-99
lines changed

‎README.md‎

Lines changed: 56 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,71 @@
1-
<div align="center">
2-
<sub>
1+
<p align="center">
2+
<a href="https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline"><img src="https://img.shields.io/visual-studio-marketplace/v/RooVeterinaryInc.roo-cline.svg?label=VS%20Code%20Marketplace" alt="VS Code Marketplace"></a>
3+
<a href="https://x.com/roo_code"><img src="https://img.shields.io/twitter/follow/roo_code?style=flat&logo=x&color=555" alt="X (Twitter)"></a>
4+
<a href="https://discord.gg/roocode"><img src="https://img.shields.io/discord/1332146336664915968?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
5+
<a href="https://www.reddit.com/r/RooCode/"><img src="https://img.shields.io/reddit/subreddit-subscribers/RooCode?style=flat&logo=reddit&logoColor=white" alt="Reddit"></a>
6+
</p>
7+
8+
# Roo Code
9+
10+
> Roo Code is an open-source VS Code AI agent. While we are technically a fork of Cline, let's be clear: our path has radically diverged. We're building something fundamentally different.
11+
12+
<details>
13+
<summary>🌐 Available languages</summary>
14+
15+
- [English](README.md)
16+
- [Català](locales/ca/README.md)
17+
- [Deutsch](locales/de/README.md)
18+
- [Español](locales/es/README.md)
19+
- [Français](locales/fr/README.md)
20+
- [हिंदी](locales/hi/README.md)
21+
- [Bahasa Indonesia](locales/id/README.md)
22+
- [Italiano](locales/it/README.md)
23+
- [日本語](locales/ja/README.md)
24+
- [한국어](locales/ko/README.md)
25+
- [Nederlands](locales/nl/README.md)
26+
- [Polski](locales/pl/README.md)
27+
- [Português (BR)](locales/pt-BR/README.md)
28+
- [Русский](locales/ru/README.md)
29+
- [Türkçe](locales/tr/README.md)
30+
- [Tiếng Việt](locales/vi/README.md)
31+
- [简体中文](locales/zh-CN/README.md)
32+
- [繁體中文](locales/zh-TW/README.md)
33+
- ...
34+
</details>
335

4-
<b>English</b> • [Català](locales/ca/README.md) • [Deutsch](locales/de/README.md) • [Español](locales/es/README.md) • [Français](locales/fr/README.md) • [हिंदी](locales/hi/README.md) • [Bahasa Indonesia](locales/id/README.md) • [Italiano](locales/it/README.md) • [日本語](locales/ja/README.md)
36+
---
537

6-
</sub>
7-
<sub>
38+
## What Can Roo Code Do For YOU?
839

9-
[한국어](locales/ko/README.md) • [Nederlands](locales/nl/README.md) • [Polski](locales/pl/README.md) • [Português (BR)](locales/pt-BR/README.md) • [Русский](locales/ru/README.md) • [Türkçe](locales/tr/README.md) • [Tiếng Việt](locales/vi/README.md) • [简体中文](locales/zh-CN/README.md) • [繁體中文](locales/zh-TW/README.md)
40+
- Generate Code from natural language descriptions
41+
- Refactor & Debug existing code
42+
- Write & Update documentation
43+
- Answer Questions about your codebase
44+
- Automate repetitive tasks
45+
- Utilize MCP Servers
1046

11-
</sub>
12-
</div>
13-
<br>
14-
<div align="center">
15-
<h1>Roo Code</h1>
16-
<p align="center">
17-
<img src="https://media.githubusercontent.com/media/RooCodeInc/Roo-Code/main/src/assets/docs/demo.gif" width="100%" />
18-
</p>
19-
<p>Connect with developers, contribute ideas, and stay ahead with the latest AI-powered coding tools.</p>
20-
21-
<a href="https://discord.gg/roocode" target="_blank"><img src="https://img.shields.io/badge/Join%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join Discord"></a>
22-
<a href="https://www.reddit.com/r/RooCode/" target="_blank"><img src="https://img.shields.io/badge/Join%20Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white" alt="Join Reddit"></a>
23-
24-
</div>
25-
<br>
26-
<br>
47+
## Tutorial & Feature Videos
2748

2849
<div align="center">
2950

30-
<a href="https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline" target="_blank"><img src="https://img.shields.io/badge/Download%20on%20VS%20Marketplace-blue?style=for-the-badge&logo=visualstudiocode&logoColor=white" alt="Download on VS Marketplace"></a>
31-
<a href="https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop" target="_blank"><img src="https://img.shields.io/badge/Feature%20Requests-yellow?style=for-the-badge" alt="Feature Requests"></a>
32-
<a href="https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline&ssr=false#review-details" target="_blank"><img src="https://img.shields.io/badge/Rate%20%26%20Review-green?style=for-the-badge" alt="Rate & Review"></a>
33-
<a href="https://docs.roocode.com" target="_blank"><img src="https://img.shields.io/badge/Documentation-6B46C1?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Documentation"></a>
51+
| | | |
52+
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
53+
| <a href="https://www.youtube.com/watch?v=Mcq3r1EPZ-4"><img src="https://img.youtube.com/vi/Mcq3r1EPZ-4/maxresdefault.jpg" width="100%"></a><br><b>Installing Roo Code</b> | <a href="https://www.youtube.com/watch?v=eEJErgZBqLE"><img src="https://img.youtube.com/vi/eEJErgZBqLE/maxresdefault.jpg" width="100%"></a><br><b>Configuring Profiles</b> | <a href="https://www.youtube.com/watch?v=r1bpod1VWhg"><img src="https://img.youtube.com/vi/r1bpod1VWhg/maxresdefault.jpg" width="100%"></a><br><b>Codebase Indexing</b> |
54+
| <a href="https://www.youtube.com/watch?v=qgqceCuhlRA"><img src="https://img.youtube.com/vi/qgqceCuhlRA/maxresdefault.jpg" width="100%"></a><br><b>Custom Modes</b> | <a href="https://www.youtube.com/watch?v=Ho30nyY332E"><img src="https://img.youtube.com/vi/Ho30nyY332E/maxresdefault.jpg" width="100%"></a><br><b>Checkpoints</b> | <a href="https://www.youtube.com/watch?v=6h5vB9PpoPk"><img src="https://img.youtube.com/vi/6h5vB9PpoPk/maxresdefault.jpg" width="100%"></a><br><b>Todo Lists</b> |
3455

3556
</div>
36-
37-
**Roo Code** is an AI-powered **autonomous coding agent** that lives in your editor. It can:
38-
39-
- Communicate in natural language
40-
- Read and write files directly in your workspace
41-
- Run terminal commands
42-
- Automate browser actions
43-
- Integrate with any OpenAI-compatible or custom API/model
44-
- Adapt its “personality” and capabilities through **Custom Modes**
45-
46-
Whether you’re seeking a flexible coding partner, a system architect, or specialized roles like a QA engineer or product manager, Roo Code can help you build software more efficiently.
47-
48-
Check out the [CHANGELOG](CHANGELOG.md) for detailed updates and fixes.
49-
50-
---
51-
52-
## What Can Roo Code Do?
53-
54-
- 🚀 **Generate Code** from natural language descriptions
55-
- 🔧 **Refactor & Debug** existing code
56-
- 📝 **Write & Update** documentation
57-
- 🤔 **Answer Questions** about your codebase
58-
- 🔄 **Automate** repetitive tasks
59-
- 🏗️ **Create** new files and projects
60-
61-
## Quick Start
62-
63-
1. [Install Roo Code](https://docs.roocode.com/getting-started/installing)
64-
2. [Connect Your AI Provider](https://docs.roocode.com/getting-started/connecting-api-provider)
65-
3. [Try Your First Task](https://docs.roocode.com/getting-started/your-first-task)
66-
67-
## Key Features
68-
69-
### Multiple Modes
70-
71-
Roo Code adapts to your needs with specialized [modes](https://docs.roocode.com/basic-usage/using-modes):
72-
73-
- **Code Mode:** For general-purpose coding tasks
74-
- **Architect Mode:** For planning and technical leadership
75-
- **Ask Mode:** For answering questions and providing information
76-
- **Debug Mode:** For systematic problem diagnosis
77-
- **[Custom Modes](https://docs.roocode.com/advanced-usage/custom-modes):** Create unlimited specialized personas for security auditing, performance optimization, documentation, or any other task
78-
79-
### Smart Tools
80-
81-
Roo Code comes with powerful [tools](https://docs.roocode.com/basic-usage/how-tools-work) that can:
82-
83-
- Read and write files in your project
84-
- Execute commands in your VS Code terminal
85-
- Control a web browser
86-
- Use external tools via [MCP (Model Context Protocol)](https://docs.roocode.com/advanced-usage/mcp)
87-
88-
MCP extends Roo Code's capabilities by allowing you to add unlimited custom tools. Integrate with external APIs, connect to databases, or create specialized development tools - MCP provides the framework to expand Roo Code's functionality to meet your specific needs.
89-
90-
### Customization
91-
92-
Make Roo Code work your way with:
93-
94-
- [Custom Instructions](https://docs.roocode.com/advanced-usage/custom-instructions) for personalized behavior
95-
- [Custom Modes](https://docs.roocode.com/advanced-usage/custom-modes) for specialized tasks
96-
- [Local Models](https://docs.roocode.com/advanced-usage/local-models) for offline use
97-
- [Auto-Approval Settings](https://docs.roocode.com/advanced-usage/auto-approving-actions) for faster workflows
57+
<p align="center">
58+
<a href="https://docs.roocode.com/tutorial-videos">More quick tutorial and feature videos...</a>
59+
</p>
9860

9961
## Resources
10062

101-
### Documentation
102-
103-
- [Basic Usage Guide](https://docs.roocode.com/basic-usage/the-chat-interface)
104-
- [Advanced Features](https://docs.roocode.com/advanced-usage/auto-approving-actions)
105-
- [Frequently Asked Questions](https://docs.roocode.com/faq)
106-
107-
### Community
108-
109-
- **Discord:** [Join our Discord server](https://discord.gg/roocode) for real-time help and discussions
110-
- **Reddit:** [Visit our subreddit](https://www.reddit.com/r/RooCode) to share experiences and tips
111-
- **GitHub:** Report [issues](https://github.com/RooCodeInc/Roo-Code/issues) or request [features](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop)
63+
- **[Documentation](https://docs.roocode.com):** The official guide to installing, configuring, and mastering Roo Code.
64+
- **[YouTube Channel](https://youtube.com/@roocodeyt?feature=shared):** Watch tutorials and see features in action.
65+
- **[Discord Server](https://discord.gg/roocode):** Join the community for real-time help and discussion.
66+
- **[Reddit Community](https://www.reddit.com/r/RooCode):** Share your experiences and see what others are building.
67+
- **[GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues):** Report bugs and track development.
68+
- **[Feature Requests](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop):** Have an idea? Share it with the developers.
11269

11370
---
11471

0 commit comments

Comments
 (0)