Skip to content

Commit

Permalink
Update readme with adamant_env.sh arguments
Browse files Browse the repository at this point in the history
Apply fixes to Linux README.md
  • Loading branch information
Jbsco committed Jun 6, 2024
1 parent 57de64f commit 22aebe5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ This procedure is used to create a new Docker container that hosts the Adamant b
$ git clone https://github.com/lasp/adamant.git
```

3. Next, tell Docker to create a new container from the [pre-built image](https://github.com/lasp/adamant_example/pkgs/container/adamant_example). This make take a few minutes and ~3 GB of disk space. By default the container created is named `adamant_example_container`. To change this, or the image that the container uses, modify `docker_config.sh` before running the commands below.
3. Next, tell Docker to create a new container from the [pre-built image](https://github.com/lasp/adamant_example/pkgs/container/adamant_example). This make take a few minutes and ~3 GB of disk space. By default the container created is named `adamant_example_container`. To change this, or the image that the container uses, modify `compose.yaml` before running the commands below.

```
$ cd adamant_example/docker
$ ./create_container.sh
$ ./adamant_env.sh start
```

4. Finally, you can log into the container by running.

```
$ ./login_container.sh
$ ./adamant_env.sh login
```

The first time you log in, the environment will be set up automatically. This can take a few minutes. Note that the `adamant_example/` and `adamant/` directories on your host will be shared with the new Docker container at `~/adamant_example/` and `~/adamant/`. This allows you to modify files on your host and compile those same files on the container.
Expand All @@ -36,21 +36,21 @@ The first time you log in, the environment will be set up automatically. This ca
Once you have created a container using the section above, you can stop it by running.

```
$ ./stop_container.sh
$ ./adamant_env.sh stop
```

To start the container up again, run:

```
$ ./start_container.sh
$ ./adamant_env.sh start
```

## Running the Example Project

To build and run the example project (for Linux) we need to first log in to the container.

```
$ ./login_container.sh
$ ./adamant_env.sh login
```

From within the container run:
Expand All @@ -73,7 +73,7 @@ Next, you can create the Docker image by running:

```
$ cd adamant_example/docker
$ ./build_image.sh
$ ./adamant_env.sh build
```

This may take several minutes to complete. By default, the image created is named `ghcr.io/lasp/adamant_example:latest`. To change this, modify `compose.yaml` before running `./adamant_env.sh build`.

0 comments on commit 22aebe5

Please sign in to comment.