Apply README corrections from code review

Co-authored-by: Jeremy Wright <[email protected]>
Wakoma · Jul 8, 2024 · c942be2 · c942be2
1 parent 55cc362
commit c942be2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/nimble_build_system/README.md b/nimble_build_system/README.md
@@ -2,6 +2,6 @@ The nimble build system is a python module containing custom functionality for b
 
 This is divided into three sub-packages:
 
-* `cad` - This containts any helper functions for building the Nimble CAD models. This does not contain the scripts for generating specific CAD models and assemblies. These are held in the `mechanical` directory of the repository.
+* `cad` - This contains any helper functions for building the Nimble CAD models. This does not contain the scripts for generating specific CAD models and assemblies. These are held in the `mechanical` directory of the repository.
 * `orchestration` - This contains code for the Nimble project's interaction with [CadOrchestrator](https://gitlab.com/gitbuilding/cadorchestrator)
-* `utils` - This contains scripts assorted utility scripts, for example for updating the json configuration files.
+* `utils` - This contains assorted utility scripts, for example for updating the JSON configuration files.
diff --git a/nimble_build_system/utils/README.md b/nimble_build_system/utils/README.md
@@ -16,7 +16,7 @@ The `devices.json` file it creates is committed to the repository.
 
 This script used `devices.json` to create the configuration used by CadOrchestrator to set the configuration options that the user can select when generating a nimble.
 
-Assuming that the `nimble_build_system` is installed using setup.py. This script is as an entry point and should be on your PATH.
+Assuming that the `nimble_build_system` is installed using setup.py, this script is as an entry point and should be on your PATH.
 
 Starting in the root directory of this project, run: