Add notes on installing cram. Fix #17.

The latest published version of cram doesn't work for us. We need a development version, as specifed in the `requirements.txt` file. This is now documented.

Add notes on installing cram. Fix #17.
The latest published version of cram doesn't work for us. We need a development version, as specifed in the `requirements.txt` file. This is now documented.
Shrikant Sharat
1 parent 290edb0058
Showing 1 changed file with 6 additions and 4 deletions Side-by-side Diff
README.mkd
@@ -440,13 +440,15 @@ mentioned above.
 ## Running the tests
  
 All the tests are in the `tests` folder and are run using the [cram][] test
-system.  Once you have cram installed, you can run the tests as
+system. The latest version on that website, as of today is v0.5, which does not
+have the `--shell` argument which is required to run our tests. So, to get the
+correct version of cram, run
  
-    make
+    pip install -r requirements.txt
  
-or
+With that, once you have cram installed, you can run the tests as
  
-    make tests
+    make
  
 If you are making a feature addition, I'd really appreciate if you can add a
 test for your feature. Even if you can add a test for an existing feature, that
...	...	@@ -440,13 +440,15 @@ mentioned above.
440	440	## Running the tests
441	441
442	442	All the tests are in the `tests` folder and are run using the [cram][] test
443		-system. Once you have cram installed, you can run the tests as
	443	+system. The latest version on that website, as of today is v0.5, which does not
	444	+have the `--shell` argument which is required to run our tests. So, to get the
	445	+correct version of cram, run
444	446
445		- make
	447	+ pip install -r requirements.txt
446	448
447		-or
	449	+With that, once you have cram installed, you can run the tests as
448	450
449		- make tests
	451	+ make
450	452
451	453	If you are making a feature addition, I'd really appreciate if you can add a
452	454	test for your feature. Even if you can add a test for an existing feature, that