From ef22563d36e3d7c826e40e7781e9210ebde73c6a Mon Sep 17 00:00:00 2001 From: Alexis Lefebvre Date: Tue, 13 Sep 2022 00:08:03 +0200 Subject: [PATCH] README: update the Docker part (#1870) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It was written: > If you the build directory you'll need… I tried to fix it, hopefully I found the correct wording. Otherwise please let me know what was missing. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c4f2b8296c..af59ec1ff7 100644 --- a/README.md +++ b/README.md @@ -112,13 +112,13 @@ This will create an image with all required dependencies and already built. docker run -v "$(pwd)"/build:/home/jak/jak-project/build -it jak bash ``` -Note: If you the build directory you'll need to rerun the build command. Alteratively you can get the build via `docker cp` +Note: If you change the content of the `build/` directory you'll need to rerun the `build` command. Alteratively you can get the build via `docker cp`. -This will link your build folder to the images so can validate your build or test it on an external device. +This will link your `build/` folder to the images so can validate your build or test it on an external device. Docker images can be linked into your IDE (e.g. CLion) to help with codesniffing, static analysis, run tests and continuous build. -Unfortently you'll still need task runner on your local machine to run the game or instead, manually run the game via the commands found in `Taskfile.yml` +Unfortunately you'll still need task runner on your local machine to run the game or instead, manually run the game via the commands found in `Taskfile.yml`. ### Linux