diff --git a/README.md b/README.md index ea775c2..0bd6812 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Unity Test ![CI](https://github.com/ThrowTheSwitch/Unity/workflows/CI/badge.svg) +# Unity Test ![CI][] __Copyright (c) 2007 - 2021 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams__ @@ -11,16 +11,16 @@ too much headache. You may use any compiler you wish, and may use most existing including Make, CMake, etc. If you'd like to leave the hard work to us, you might be interested in Ceedling, a build tool also by ThrowTheSwitch.org. -If you're new to Unity, we encourage you to tour the [getting started guide](docs/UnityGettingStartedGuide.md) +If you're new to Unity, we encourage you to tour the [getting started guide][]. ## Getting Started -The [docs](docs/) folder contains a [getting started guide](docs/UnityGettingStartedGuide.md) +The [docs][] folder contains a [getting started guide][] and much more tips about using Unity. ## Unity Assertion Summary -For the full list, see [UnityAssertionsReference.md](docs/UnityAssertionsReference.md). +For the full list, see [UnityAssertionsReference.md][]. ### Basic Validity Tests @@ -185,3 +185,8 @@ standard types... but since it's a memory compare, you have to be careful that y you can append `\_MESSAGE` to any of the macros to make them take an additional argument. This argument is a string that will be printed at the end of the failure strings. This is useful for specifying more information about the problem. + +[CI]: https://github.com/ThrowTheSwitch/Unity/workflows/CI/badge.svg +[getting started guide]: docs/UnityGettingStartedGuide.md +[docs]: docs/ +[UnityAssertionsReference.md]: docs/UnityAssertionsReference.md diff --git a/docs/ThrowTheSwitchCodingStandard.md b/docs/ThrowTheSwitchCodingStandard.md index 29787c8..bb977f0 100644 --- a/docs/ThrowTheSwitchCodingStandard.md +++ b/docs/ThrowTheSwitchCodingStandard.md @@ -187,4 +187,6 @@ that happens, we like to indent further to line things up in nice tidy columns. Egad. Really? We use mark down and we like pdf files because they can be made to look nice while still being portable. Good enough? -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +*Find The Latest of This And More at [ThrowTheSwitch.org][]* + +[ThrowTheSwitch.org]: https://throwtheswitch.org \ No newline at end of file diff --git a/docs/UnityAssertionsReference.md b/docs/UnityAssertionsReference.md index 09e251f..f618c72 100644 --- a/docs/UnityAssertionsReference.md +++ b/docs/UnityAssertionsReference.md @@ -34,7 +34,7 @@ execution and reports an error through some appropriate I/O channel (e.g. stdout, GUI, file, blinky light). Fundamentally, for dynamic verification all you need is a single assertion -mechanism. In fact, that's what the [assert() macro in C's standard library](http://en.wikipedia.org/en/wiki/Assert.h) +mechanism. In fact, that's what the [assert() macro][] in C's standard library is for. So why not just use it? Well, we can do far better in the reporting department. C's `assert()` is pretty dumb as-is and is particularly poor for handling common data types like arrays, structs, etc. And, without some other @@ -781,4 +781,7 @@ operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap your `int` in the wrong place, and you could experience false failures. You can always back down to a simple `TEST_ASSERT` and do the operations yourself. -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +*Find The Latest of This And More at [ThrowTheSwitch.org][]* + +[assert() macro]: http://en.wikipedia.org/en/wiki/Assert.h +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityConfigurationGuide.md b/docs/UnityConfigurationGuide.md index e2e3d8e..eddc79c 100644 --- a/docs/UnityConfigurationGuide.md +++ b/docs/UnityConfigurationGuide.md @@ -559,4 +559,6 @@ The defines and macros in this guide should help you port Unity to just about any C target we can imagine. If you run into a snag or two, don't be afraid of asking for help on the forums. We love a good challenge! -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +*Find The Latest of This And More at [ThrowTheSwitch.org][]* + +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityGettingStartedGuide.md b/docs/UnityGettingStartedGuide.md index 85f8d4d..039364f 100644 --- a/docs/UnityGettingStartedGuide.md +++ b/docs/UnityGettingStartedGuide.md @@ -108,7 +108,7 @@ call. Remembering to add each test to the main function can get to be tedious. If you enjoy using helper scripts in your build process, you might consider making use -of our handy [generate_test_runner.rb](../auto/generate_test_runner.rb) script. +of our handy [generate_test_runner.rb][] script. This will create the main function and all the calls for you, assuming that you have followed the suggested naming conventions. In this case, there is no need for you to include the main function in your test file at all. @@ -252,4 +252,7 @@ This flexibility of separating tests into individual executables allows us to much more thoroughly unit test our system and it keeps all the test code out of our final release! -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +*Find The Latest of This And More at [ThrowTheSwitch.org][]* + +[generate_test_runner.rb]: ../auto/generate_test_runner.rb +[ThrowTheSwitch.org]: https://throwtheswitch.org diff --git a/docs/UnityHelperScriptsGuide.md b/docs/UnityHelperScriptsGuide.md index a95e9ef..c2e91fe 100644 --- a/docs/UnityHelperScriptsGuide.md +++ b/docs/UnityHelperScriptsGuide.md @@ -6,7 +6,7 @@ Sometimes what it takes to be a really efficient C programmer is a little non-C. The Unity project includes a couple of Ruby scripts for making your life just a tad easier. They are completely optional. If you choose to use them, you'll need a copy of Ruby, of course. Just install whatever the latest version is, and it is -likely to work. You can find Ruby at [ruby-lang.org](https://ruby-labg.org/). +likely to work. You can find Ruby at [ruby-lang.org][]. ### `generate_test_runner.rb` @@ -54,7 +54,7 @@ generated file. The example immediately below will create TestFile_Runner.c. ruby generate_test_runner.rb TestFile.c ``` -You can also add a [YAML](http://www.yaml.org/) file to configure extra options. +You can also add a [YAML][] file to configure extra options. Conveniently, this YAML file is of the same format as that used by Unity and CMock. So if you are using YAML files already, you can simply pass the very same file into the generator script. @@ -216,8 +216,8 @@ ignored and failing tests in this project generate corresponding entries in the summary report. If you're interested in other (prettier?) output formats, check into the -Ceedling build tool project (ceedling.sourceforge.net) that works with Unity and -CMock and supports xunit-style xml as well as other goodies. +[Ceedling][] build tool project that works with Unity and CMock and supports +xunit-style xml as well as other goodies. This script assumes the existence of files ending with the extensions `.testpass` and `.testfail`.The contents of these files includes the test @@ -267,4 +267,9 @@ OVERALL UNITY TEST SUMMARY How convenient is that? -*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)* +*Find The Latest of This And More at [ThrowTheSwitch.org][]* + +[ruby-lang.org]: https://ruby-labg.org/ +[YAML]: http://www.yaml.org/ +[Ceedling]: http://www.throwtheswitch.org/ceedling +[ThrowTheSwitch.org]: https://throwtheswitch.org