Skip to content

Commit

Permalink
[skip ci] Update docs for dev env setup per #1283. (#1309)
Browse files Browse the repository at this point in the history
  • Loading branch information
aj-stein-nist authored and david-waltermire committed Aug 23, 2022
1 parent cd7068a commit 320c607
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ A Docker container configuration is provided that establishes the runtime enviro
docker compose run cli
```

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:
In Windows environments, you may need to execute in a pseudoterminal (pty) that allows for using an interactive shell. In such a case, you can run the Docker container with [`winpty`](https://github.com/rprichard/winpty) as follows:


```
Expand Down Expand Up @@ -72,7 +72,7 @@ The following steps are known to work on [Ubuntu](https://ubuntu.com/) (tested i
hugo version
```

1. Install Node.js modules
1. Install Node.js modules and set path

To install the supported Node.js modules pinned as a dependency in the repository, run the following:

Expand Down Expand Up @@ -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][./build/ci-cd/config/metaschema].
This will generate schemas based on the Metaschema definitions in the Metaschema [configuration file](./ci-cd/config/metaschema).
### Building XML-to-JSON and JSON-to-XML Converters for the OSCAL models
Expand All @@ -140,7 +140,7 @@ To build the XML-to-JSON and JSON-to-XML Converters for the OSCAL models, run th
./build/ci-cd/generate-content-converters.sh
```
This will generate converters based on the definitions in the metaschema [configuration file][metaschema-config].
This will generate converters based on the definitions in the Metaschema [configuration file](./ci-cd/config/metaschema).
### Building Website Documentation
Expand Down

0 comments on commit 320c607

Please sign in to comment.