Skip to content

Commit f74b807

Browse files
mamoodimamoodi
authored
Update README and doc intro to be consistent with each other (OpenHands#1954)
1 parent d60aa2b commit f74b807

6 files changed

Lines changed: 18 additions & 149 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,22 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and
4444

4545
![App screenshot](./docs/static/img/screenshot.png)
4646

47-
## ⚡ Quick Start
48-
You can run OpenDevin with Docker. It works best with the most recent
49-
version of Docker, `26.0.0`.
47+
## ⚡ Getting Started
48+
The easiest way to run OpenDevin is inside a Docker container. It works best with the most recent version of Docker, `26.0.0`.
49+
You must be using Linux, Mac OS, or WSL on Windows.
50+
51+
To start the app, run these commands, replacing `$(pwd)/workspace` with the directory you want OpenDevin to work with.
5052

5153
```bash
52-
#The directory you want OpenDevin to modify. MUST be an absolute path!
54+
# The directory you want OpenDevin to work with. MUST be an absolute path!
5355
export WORKSPACE_BASE=$(pwd)/workspace;
56+
```
57+
58+
> [!WARNING]
59+
> OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine.
60+
> But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.
5461
62+
```bash
5563
docker run \
5664
-it \
5765
--pull=always \
@@ -64,6 +72,8 @@ docker run \
6472
ghcr.io/opendevin/opendevin:0.5
6573
```
6674

75+
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000).
76+
6777
## 🚀 Documentation
6878

6979
To learn more about the project, and for tips on using OpenDevin,

‎docs/modules/usage/intro.mdx‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,13 @@ Explore the codebase of OpenDevin on [GitHub](https://github.com/OpenDevin/OpenD
5858

5959
## 🛠️ Getting Started
6060

61-
The easiest way to run OpenDevin is inside a Docker container.
61+
The easiest way to run OpenDevin is inside a Docker container. It works best with the most recent version of Docker, `26.0.0`.
62+
You must be using Linux, Mac OS, or WSL on Windows.
6263

6364
To start the app, run these commands, replacing `$(pwd)/workspace` with the directory you want OpenDevin to work with.
6465

6566
```
66-
# Your OpenAI API key, or any other LLM API key
67-
export LLM_API_KEY="sk-..."
68-
```
69-
70-
```
71-
# The directory you want OpenDevin to modify.
72-
# MUST be an absolute path!
67+
# The directory you want OpenDevin to work with. MUST be an absolute path!
7368
export WORKSPACE_BASE=$(pwd)/workspace
7469
```
7570

@@ -91,7 +86,7 @@ docker run \
9186
ghcr.io/opendevin/opendevin:0.5
9287
```
9388

94-
You'll find opendevin running at [http://localhost:3000](http://localhost:3000).
89+
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000).
9590

9691
:::tip
9792
If you want to use the **(unstable!)** bleeding edge, you can use `ghcr.io/opendevin/opendevin:main` as the image (last line).

‎docs/src/components/Code/Code.tsx‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎docs/src/components/Code/CodeBlock.tsx‎

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎docs/src/components/Code/styles.module.css‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎docs/src/pages/index.tsx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
22
import Layout from "@theme/Layout";
33

4-
import { Code } from "../components/Code/Code";
54
import { HomepageHeader } from "../components/HomepageHeader/HomepageHeader";
65
import { Welcome } from "../components/Welcome/Welcome";
76

@@ -25,7 +24,6 @@ export default function Home(): JSX.Element {
2524
<HomepageHeader />
2625
<div>
2726
<Welcome />
28-
<Code />
2927
</div>
3028
</div>
3129
</Layout>

0 commit comments

Comments
 (0)