diff options
Diffstat (limited to 'FreeRTOS-Plus/Test/CMock/README.md')
| -rw-r--r-- | FreeRTOS-Plus/Test/CMock/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/FreeRTOS-Plus/Test/CMock/README.md b/FreeRTOS-Plus/Test/CMock/README.md new file mode 100644 index 000000000..112007367 --- /dev/null +++ b/FreeRTOS-Plus/Test/CMock/README.md @@ -0,0 +1,34 @@ +CMock - Mock/stub generator for C +================================= + +[](https://travis-ci.org/ThrowTheSwitch/CMock) + +Getting Started +================ + +If you're using Ceedling, there is no need to install CMock. It will handle it for you. +For everyone else, the simplest way is to grab it off github. You can also download it +as a zip if you prefer. The Github method looks something like this: + + > git clone --recursive https://github.com/throwtheswitch/cmock.git + > cd cmock + > bundle install # Ensures you have all RubyGems needed + +If you plan to help with the development of CMock (or just want to verify that it can +perform its self tests on your system) then you can enter the test directory and then +ask it to test: + + > cd test + > rake # Run all CMock self tests + +API Documentation +================= + +* Not sure what you're doing? + * [View docs/CMock_Summary.md](docs/CMock_Summary.md) +* Interested in our MIT-style license? + * [View docs/license.txt](docs/license.txt) +* Are there examples? + * They are all in [/examples](examples/) +* Any other resources to check out? + * Definitely! Check out our developer portal on [ThrowTheSwitch.org](http://throwtheswitch.org) |