From 9312353d20d43af140a34274835592189f773e3b Mon Sep 17 00:00:00 2001 From: Colin Seymour Date: Tue, 20 Jun 2017 10:29:17 +0200 Subject: [PATCH] Improve running from cloned repo docs (#3669) * Improve running from cloned repo docs --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 27d44323..54cbacc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,6 +67,16 @@ For development you are going to want to checkout out the source. To get it, clo cd linguist/ script/bootstrap +To run Linguist from the cloned repository, you will need to generate the code samples first: + + bundle exec rake samples + +Run this command each time a [sample][samples] has been modified. + +To run Linguist from the cloned repository: + + bundle exec bin/linguist --breakdown + To run the tests: bundle exec rake test