Skip to content

Commit

Permalink
Merge pull request #353 from KaanS139/development
Browse files Browse the repository at this point in the history
PowerShell instructions addition
  • Loading branch information
pgleeson authored Jun 24, 2024
2 parents 77c22a1 + cb7b164 commit 9b7c146
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ We have put together a [Docker container](https://hub.docker.com/r/openworm/open

## Running

1. Ensure the Docker daemon is running in the background (on MacOS/Windows there should be an icon with the Docker whale logo showing in the menu bar/system tray).
1. Ensure the Docker daemon is running in the background (on MacOS/Windows there should be an icon with the Docker whale logo showing in the menu bar/system tray).
2. Open a terminal and run:
```bash
git clone http://github.com/openworm/openworm
cd openworm
```
3. Optional: Run `./build.sh` (or `build.cmd` on Windows). If you skip this step, it will download the latest released Docker image from the [OpenWorm Docker hub](https://hub.docker.com/r/openworm/openworm).
4. Run `./run.sh` (or `run.cmd` on Windows).
3. Optional: Run `./build.sh` (`build.cmd` on Windows or `.\build.cmd` on [PowerShell](https://learn.microsoft.com/en-us/powershell/dsc/overview?view=dsc-2.0)). If you skip this step, it will download the latest released Docker image from the [OpenWorm Docker hub](https://hub.docker.com/r/openworm/openworm).
4. Run `./run.sh` (`run.cmd` on Windows or `.\run.cmd` in PowerShell).
5. About 5-10 minutes of output will display on the screen as the steps run.
6. The simulation will end. Run `stop.sh` (`stop.cmd` on Windows) on your system to clean up the running container.
6. The simulation will end. Run `stop.sh` (`stop.cmd` on Windows or `.\stop.cmd` in PowerShell) on your system to clean up the running container.
7. Inspect the output in the `output` directory on your local machine.

## Advanced
Expand All @@ -62,7 +62,7 @@ We have put together a [Docker container](https://hub.docker.com/r/openworm/open

### Other Things to Try

- Open a terminal and run `./run-shell-only.sh` (or `run-shell-only.cmd` on Windows). This will let you log into the container before it has run `master_openworm.py`. From here you can inspect the internals of the various checked out code bases and installed systems and modify things. Afterwards, you'll still need to run `./stop.sh` to clean up.
- Open a terminal and run `./run-shell-only.sh` (`run-shell-only.cmd` on Windows or `.\run-shell-only.cmd` in PowerShell). This will let you log into the container before it has run `master_openworm.py`. From here you can inspect the internals of the various checked out code bases and installed systems and modify things. Afterwards, you'll still need to run `./stop.sh` to clean up.
- If you wish to modify what gets installed, you should modify `Dockerfile`. If you want to modify what runs, you should modify `master_openworm.py`. Either way you will need to run `build.sh` in order to rebuild the image locally. Afterwards, you can run normally.

## FAQ
Expand Down

0 comments on commit 9b7c146

Please sign in to comment.