diff --git a/README-OSX.md b/README-OSX.md new file mode 100644 index 0000000000..9fdc58587e --- /dev/null +++ b/README-OSX.md @@ -0,0 +1,18 @@ +To work on the project on OSX: + +Requirements: +Docker Desktop (for OSX) +docker-sync (`gem install docker-sync`) + +From the root directory of the repo, first build the image and tag it 'oot': +`docker build . -t oot` + +Then, start docker-sync: +docker-sync-stack start + +After a lot of waiting, you'll see something like "Attaching to oot_oot_1". This means you're good to go. Ctrl+c on this tab to close the container and docker-sync. + +Open a new tab and log into the container. To get the container id, use 'docker container ls' and grab the ID from the container with image oot:latest +docker exec-it /bin/bash + +Run `make setup` followed by `make`, and you're off to the races! diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000000..a6cdbbdf8e --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +version: "3" +services: + oot: + volumes: + - oot-sync:/oot:nocopy + image: "oot:latest" + tty: true + +volumes: + oot-sync: + external: true diff --git a/docker-sync.yml b/docker-sync.yml new file mode 100644 index 0000000000..089afe26f8 --- /dev/null +++ b/docker-sync.yml @@ -0,0 +1,5 @@ +version: "2" + +syncs: + oot-sync: + src: '.'