diff --git a/README.md b/README.md index 7dfa0cdb..897ef48f 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# kscale-sim-library +# K-Scale Sim Library + +## Getting Started + +1. Clone this repository: + +```bash +git clone git@github.com:kscalelabs/sim.git +cd sim +``` + +2. Install the Isaac Docker image: + +```bash +./sim/scripts/install_isaac_dependencies.sh +``` + +3. Start the Isaac Docker image in Headless mode (assuming you're working in a server environment): + +```bash +./sim/scripts/install_isaac_dependencies.sh +# Inside the Docker container +./runheadless.native.sh -v +``` diff --git a/sim/scripts/run_headless.sh b/sim/scripts/run_headless.sh index bbcd567e..0d43c904 100755 --- a/sim/scripts/run_headless.sh +++ b/sim/scripts/run_headless.sh @@ -1,7 +1,13 @@ #!/bin/bash # Runs Isaac in headless mode. -docker run --name isaac-sim --entrypoint bash -it --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \ +docker run \ + --name isaac-sim \ + --entrypoint bash \ + -it \ + --gpus all \ + -e "ACCEPT_EULA=Y" \ + --rm --network=host \ -e "PRIVACY_CONSENT=Y" \ -v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \ -v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \