Skip to content

Commit

Permalink
Fix broken docker instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanTAllen committed Dec 5, 2024
1 parent 2246089 commit 5c082aa
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions INSTALL_DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,55 +19,55 @@ The docker images also include common Pony tools like [ponyup](https://github.co
You'll need to install Docker using [the instructions here](https://docs.docker.com/engine/installation/). Then you can pull a pony docker image using the following command (where TAG is the tag you want to use)

```bash
docker pull docker://ghcr.io/ponylang/ponyc:TAG
docker pull ghcr.io/ponylang/ponyc:TAG
```

Then you'll be able to run `ponyc` to compile a Pony program in a given directory, running a command like this:

```bash
docker run -v /path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG
docker run -v /path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG
```

If you're unfamiliar with Docker, remember to ensure that whatever path you provide for `/path/to/my-code` is a full path name and not a relative path, and also note the lack of a closing slash, `/`, at the *end* of the path name.

Note that if your host doesn't match the docker container, you'll probably have to run the resulting program inside the docker container as well, using a command like this:

```bash
docker run -v /path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG ./main
docker run -v /path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG ./main
```

To compile and run in one step run a command like this:

```bash
docker run -v /path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG sh -c "ponyc && ./main"
docker run -v /path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG sh -c "ponyc && ./main"
```

### Docker for Windows

Pull an image as above:

```bash
docker pull docker://ghcr.io/ponylang/ponyc:TAG
docker pull ghcr.io/ponylang/ponyc:TAG
```

Share a local drive (volume), such as `c:`, with Docker for Windows, so that they are available to your containers. (Refer to [shared drives](https://docs.docker.com/docker-for-windows/#shared-drives) in the Docker for Windows documentation for details.)

Then you'll be able to run `ponyc` to compile a Pony program in a given directory, running a command like this:

```bash
docker run -v c:/path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG
docker run -v c:/path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG
```

Note the inserted drive letter. Replace with your drive letter as appropriate.

To run a program, run a command like this:

```bash
docker run -v c:/path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG ./main
docker run -v c:/path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG ./main
```

To compile and run in one step run a command like this:

```bash
docker run -v c:/path/to/my-code:/src/main docker://ghcr.io/ponylang/ponyc:TAG sh -c "ponyc && ./main"
docker run -v c:/path/to/my-code:/src/main ghcr.io/ponylang/ponyc:TAG sh -c "ponyc && ./main"
```

0 comments on commit 5c082aa

Please sign in to comment.