inkweaver
/
P4-in-a-Bottle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Added steps in README.md to prevent make image rebuild

This commit is contained in:
Jack Yu 2023-05-18 02:07:15 -07:00
parent 7c00f217b9
commit a8ca4ba9eb
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -44,29 +44,32 @@ Windows (without WSL), you're out-of-luck here and should proceed to the docker
instructions below. instructions below.
To use P4-in-a-Bottle with Singularity: To use P4-in-a-Bottle with Singularity:
1. Clone this repository if you haven't done so already. 1. Install singularity from [GitHub](https://github.com/sylabs/singularity/releases).
2. Install singularity from [GitHub](https://github.com/sylabs/singularity/releases). 2. Clone and enter this repository.
3. Download a pre-built image 3. Download a pre-built image
[p4iab.sif](https://git.inkweaver.net/inkweaver/P4-in-a-Bottle/releases) [p4iab.sif](https://git.inkweaver.net/inkweaver/P4-in-a-Bottle/releases)
and place it in the same directory alongside `README.md`. If you skip this and place it in the same directory alongside `README.md`.
step YOU WILL BUILD BOTH THE DOCKER CONTAINER AND THE SINGULARITY CONTAINER 4. Run `touch .docker_build p4iab.tar.gz p4iab.sif`. This prevents make from
FROM SOURCE. (Trust me, you do NOT want to build this yourself). building the container from source. If you skip this step YOU WILL BUILD
4. Run `make sc-run`. A shared directory `shared/` will be created to allow BOTH THE DOCKER CONTAINER AND THE SINGULARITY CONTAINER FROM SOURCE. (Trust
me, you do NOT want to build this yourself).
5. Run `make sc-run`. A shared directory `shared/` will be created to allow
you to move files between the container and your system. you to move files between the container and your system.
### Docker ### Docker
If you are stuck with docker, don't panic! The instructions are longer but If you are stuck with docker, don't panic! The instructions are longer but
everything should still work. everything should still work.
1. Clone this repository if you haven't done so already. 1. Install docker on your system. This should be pretty self-explanatory.
2. Install docker on your system. This should be pretty self-explanatory. 2. Clone and enter this repository.
3. Download a pre-built image 3. Download a pre-built image
[p4iab.tar.gz](https://git.inkweaver.net/inkweaver/P4-in-a-Bottle/releases) [p4iab.tar.gz](https://git.inkweaver.net/inkweaver/P4-in-a-Bottle/releases)
and place it in the same directory alongside `README.md`. Then run and place it in the same directory alongside `README.md`. Then run
`docker load -i p4iab.tar.gz && touch .docker_build`. `docker load -i p4iab.tar.gz` to import the container into docker.
If you skip this step YOU WILL BUILD THE DOCKER CONTAINER FROM SOURCE. Do 4. Run `touch .docker_build`. This tricks make into skipping the docker build
so only if you know what you are doing. commands. If you skip this step YOU WILL BUILD THE DOCKER CONTAINER FROM
4. Run `make run`. A shared directory `shared/` will be created to allow SOURCE. Do so only if you know what you are doing.
5. Run `make run`. A shared directory `shared/` will be created to allow
you to move files between the container and your system. you to move files between the container and your system.