-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc: Add GitHub Codespaces in README #2975
Conversation
@@ -45,6 +45,9 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and | |||
![App screenshot](./docs/static/img/screenshot.png) | |||
|
|||
## ⚡ Getting Started | |||
|
|||
The easiest way to run OpenDevin is to [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/OpenDevin/OpenDevin) but it is not the recommended usage path yet. For the best experience and optimal setup, please follow the docker method. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is very confusing to be part of the main README. Especially because this won't be the recommended way of running OpenDevin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, it looks strange to put a not recommend way at the beginning of main readme.
@@ -45,6 +45,9 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and | |||
![App screenshot](./docs/static/img/screenshot.png) | |||
|
|||
## ⚡ Getting Started | |||
|
|||
The easiest way to run OpenDevin is to [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/OpenDevin/OpenDevin) but it is not the recommended usage path yet. For the best experience and optimal setup, please follow the docker method. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, it looks strange to put a not recommend way at the beginning of main readme.
Yes, let's close this for now, but we can revisit it in the future as necessary. |
* Workaround for GitHub Codespaces * Add devcontainer config * rename devcontainer folder * install netcat * add VS Code Python extension * apt update * give executable path to avoid bugs * configure poetry env * fix postCreateCommand * revert executable path * add postStartCommand * run in background * Add Codespaces badge * add default config * Add Codespaces badge to doc * update comment * apply workaround 2 * refactor * fix lib path * Update on_create.sh * pass env directly to cmd * resolve unexpected merge conflicts * Separated to #2850 * Update README.md Co-authored-by: Graham Neubig <neubig@gmail.com> * Update codespaces link * Update README.md * Separated to #2975 --------- Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Graham Neubig <neubig@gmail.com>
What is the problem that this fixes or functionality that this introduces? Does it fix any open issues?
This change is separated from #2689 to avoid the blockage.