From 6e9d2752ed3e210bf650142eab0de39a2e26e13f Mon Sep 17 00:00:00 2001 From: Joel Pasvolsky <34041130+JoelPasvolsky@users.noreply.github.com> Date: Tue, 31 Oct 2023 07:03:48 -0700 Subject: [PATCH] Update readme for IDEs (#17) --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 47a55ce..59f376e 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,24 @@ pancakes are being mixed). ## Usage -Make sure requirements are installed in your developer environment with: -```bash -pip install -r requirements.txt -``` +You can run this example without installation in cloud-based IDEs that support +the [Development Containers specification](https://containers.dev/supporting) +(aka "devcontainers"). + +For development environments that do not support ``devcontainers``, install +requirements: + + pip install -r requirements.txt + +If you are cloning the repo to your local system, working in a +[virtual environment](https://docs.python.org/3/library/venv.html) is +recommended. + +Your development environment should be configured to +[access Leap’s Solvers](https://docs.ocean.dwavesys.com/en/stable/overview/sapi.html). +You can see information about supported IDEs and authorizing access to your +Leap account [here](https://docs.dwavesys.com/docs/latest/doc_leap_dev_env.html). -Or simply [open the example in Leap IDE](https://ide.dwavesys.io/#https://github.com/dwave-examples/job-shop-scheduling). Run the demo with: