Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clean up documentation for starting with project
  • Loading branch information
mvandervoord authored Apr 10, 2017
1 parent fbcffe6 commit 168da7c
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
=================
Expand Down

0 comments on commit 168da7c

Please sign in to comment.