Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation: Add MacOS with Make instructions for Exercism CLI #930

Merged
merged 3 commits into from
Dec 29, 2024
Merged

Update Documentation: Add MacOS with Make instructions for Exercism CLI #930

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d3fd3b
Added a new section for using the exercism CLI to test the exercises
cbullard-dev Dec 29, 2024
773ad88
Updated formatting, spelling and grammar for the additions for the Mac
cbullard-dev Dec 29, 2024
03787bd
Apply suggestions from code review
neenjaw Dec 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/TESTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ Errors similar to `The CXX compiler identification is unknown` will likely be re
[web-xcode-download]: https://apps.apple.com/us/app/xcode/id497799835?mt=12
[cpp-installation-instructions]: https://exercism.org/docs/tracks/cpp/installation

### Mac OS with Make _when using the exercise CLI_
#### This example will specifically assist those who want to use the Exercism CLI app for configuring, testing and submitting their CPP examples.
### MacOS with Make _when using the Exercism CLI_
#### This example specifically assists those who want to use the Exercism CLI app for configuring, testing, and submitting their C++ exercises.

The generator name for CMake is `Unix Makefiles`.
The generator name for CMake is `Unix Makefiles`.
neenjaw marked this conversation as resolved.
Show resolved Hide resolved
Assuming the current exercise is `bob` and we're in the exercise folder:

```sh
Expand All @@ -120,11 +120,10 @@ $ cmake -G "Unix Makefiles" .
$ exercism test
```

In this example we do not create empty files for the implementation before
running CMake. This is because the Exercism CLI uses the `.exercism/metadata.json` file in the root directory to parse the test
In this example, we do create empty files for the implementation before running CMake, but we do **not** create an empty build directory.
This is because the Exercism CLI uses the `.exercism/metadata.json` file in the root directory to parse the test cases.

Simply type `exercism test` in the root directory to compile the tests. This should
generate compile time errors. Once the errors are fixed, `exercism test` will build and
run the tests using the exercism CLI.
Simply type `exercism test` in the root directory to compile the tests. This should generate compile-time errors.
Once the errors are fixed, running `exercism test` again will build and execute the tests using the Exercism CLI.

[cpp-installation-instructions]: https://exercism.org/docs/tracks/cpp/installation