From 168da7c418e32c924565256624c8acf35500a7b2 Mon Sep 17 00:00:00 2001 From: Mark VanderVoord Date: Mon, 10 Apr 2017 10:04:20 -0400 Subject: [PATCH] Update README.md Clean up documentation for starting with project --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89536ea5..86192ab8 100644 --- a/README.md +++ b/README.md @@ -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 =================