diff --git a/build/README.md b/build/README.md index 82b88df444..77f39d2b2d 100644 --- a/build/README.md +++ b/build/README.md @@ -1,4 +1,4 @@ -# OSCAL Ci/CD Build Tools +# OSCAL CI/CD Build Tools This subdirectory contains a set of build scripts used to create OSCAL-related artifacts (e.g., schemas, converters, documentation). Below are instructions for building using these scripts. @@ -19,11 +19,11 @@ A Docker container configuration is provided that establishes the runtime enviro 1. Install Docker and Docker Compose - Follow the Docker installation [instructions](https://docs.docker.com/install/) for your system. - - Follow the Docker Compose installation [instructions](https://docs.docker.com/compose/install/) for your system. Note: Some docker installations also install docker compose. The installation instructions will tell you if this is the case. + - Follow the Docker Compose installation [instructions](https://docs.docker.com/compose/install/) for your system. Note: Some packages install `docker` and `docker-compose` together. The installation instructions will tell you if this is the case. 2. Build the Docker container - You can build the Docker container for the build environment using Docker Compose as follows from the OSCAL `/build` directory: + You can build the Docker container for the build environment using Docker Compose as follows from the OSCAL `./build` directory: ``` docker compose build @@ -39,7 +39,7 @@ A Docker container configuration is provided that establishes the runtime enviro docker compose run cli ``` - On Windows environments, you may need to execute in a pty that allows for using an interactive shell. In such a case you can run the Docker container as follows: + In Windows environments, you may need to execute in a pty that allows for using an interactive shell. In such a case you can run the Docker container as follows: ```