From f89f8c508172de648080e39b900a786b9a694094 Mon Sep 17 00:00:00 2001 From: Alexander Stein Date: Mon, 13 Jun 2022 14:09:58 -0400 Subject: [PATCH] [skip ci] Update docs for dev env setup per usnistgov/OSCAL#1283. (#1307) --- build/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/build/README.md b/build/README.md index 8a7d33f79d..52f36f3a69 100644 --- a/build/README.md +++ b/build/README.md @@ -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: ``` @@ -130,7 +130,7 @@ To build the XML and JSON Schema for the OSCAL models, run the following: ./build/ci-cd/generate-schema.sh ``` -This will generate schemas based on the Metaschema definitions in the metaschema [configuration file][metaschema-config]. +This will generate schemas based on the Metaschema definitions in the metaschema [configuration file][./build/ci-cd/config/metaschema]. ### Building XML-to-JSON and JSON-to-XML Converters for the OSCAL models