mirror of
https://github.com/ThrowTheSwitch/CMock.git
synced 2026-06-05 21:15:20 +00:00
Update README.md
Clean up documentation for starting with project
This commit is contained in:
@@ -6,10 +6,19 @@ CMock - Mock/stub generator for C
|
||||
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
|
||||
> bundle exec rake # Run all CMock library tests
|
||||
|
||||
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:
|
||||
|
||||
> rake # Run all CMock self tests
|
||||
|
||||
API Documentation
|
||||
=================
|
||||
|
||||
Reference in New Issue
Block a user