Skip to content

Commit 99284da

Browse files
mamoodiMahmoud Work
andauthored
Use README as the only place for getting started instructions (OpenHands#2815)
Co-authored-by: Mahmoud Work <[email protected]>
1 parent 9ccc64f commit 99284da

2 files changed

Lines changed: 12 additions & 44 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,21 @@ docker run -it \
6767
ghcr.io/opendevin/opendevin
6868
```
6969

70+
> [!NOTE]
71+
> By default, this command pulls the `latest` tag, which represents the most recent release of OpenDevin. You have other options as well:
72+
> - For a specific release version, use `ghcr.io/opendevin/opendevin:<OpenDevin_version>` (replace <OpenDevin_version> with the desired version number).
73+
> - For the most up-to-date development version, use `ghcr.io/opendevin/opendevin:main`. This version may be **(unstable!)** and is recommended for testing or development purposes only.
74+
>
75+
> Choose the tag that best suits your needs based on stability requirements and desired features.
76+
7077
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
7178

7279
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
7380

81+
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
82+
83+
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).
84+
7485
## 🚀 Documentation
7586

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

docs/modules/usage/intro.mdx

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -57,50 +57,7 @@ Explore the codebase of OpenDevin on [GitHub](https://github.com/OpenDevin/OpenD
5757
:::
5858

5959
## 🛠️ Getting Started
60-
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.
63-
64-
To start OpenDevin in a docker container, run the following commands in your terminal:
65-
66-
:::warning
67-
When you run the following command, files in `./workspace` may be modified or deleted.
68-
:::
69-
70-
```bash
71-
WORKSPACE_BASE=$(pwd)/workspace
72-
docker run -it \
73-
--pull=always \
74-
-e SANDBOX_USER_ID=$(id -u) \
75-
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
76-
-v $WORKSPACE_BASE:/opt/workspace_base \
77-
-v /var/run/docker.sock:/var/run/docker.sock \
78-
-p 3000:3000 \
79-
--add-host host.docker.internal:host-gateway \
80-
--name opendevin-app-$(date +%Y%m%d%H%M%S) \
81-
ghcr.io/opendevin/opendevin
82-
```
83-
84-
:::note
85-
By default, this command pulls the `latest` tag, which represents the most recent release of OpenDevin. You have other options as well:
86-
87-
- For a specific release version, use `ghcr.io/opendevin/opendevin:OpenDevin_version` (replace OpenDevin_version with the desired version number).
88-
- For the most up-to-date development version, use `ghcr.io/opendevin/opendevin:main`. This version may be **(unstable!)** and is recommended for testing or development purposes only.
89-
90-
Choose the tag that best suits your needs based on stability requirements and desired features.
91-
:::
92-
93-
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
94-
95-
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
96-
97-
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
98-
99-
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).
100-
101-
:::warning
102-
OpenDevin is currently a work in progress, but you can already run the alpha version to see the end-to-end system in action.
103-
:::
60+
[Check out the getting started guide on Github](https://github.com/OpenDevin/OpenDevin?tab=readme-ov-file#-getting-started)
10461

10562
[contributors-shield]: https://img.shields.io/github/contributors/opendevin/opendevin?style=for-the-badge
10663
[contributors-url]: https://github.com/OpenDevin/OpenDevin/graphs/contributors

0 commit comments

Comments
 (0)