Notes on running tests.

Shrikant Sharat
1 parent 4a1cecfff3
Showing 1 changed file with 22 additions and 1 deletions Side-by-side Diff
README.mkd
@@ -385,16 +385,36 @@ Defaults to `$HOME/.antigen`.
 were used previously but are now removed. Please use `ADOTDIR` instead, as
 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
+
+    make
+
+or
+
+    make tests
+
+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
+would be great as the tests are currently seriously lagging behind the full
+functionality of antigen.
+
 ## Notes on writing plugins
  
 > *TBD*
  
 ## Meta
  
-Project is licensed with the [MIT License][license]. To contribute, just fork,
+### Helping out
+
+Antigen is licensed with the [MIT License][license]. To contribute, just fork,
 make changes and send a pull request. If its a rather long/complicated change,
 please consider opening an [issue][] first so we can discuss it out.
  
+### Feedback please
+
 Any comments/suggestions/feedback welcome. Please join the discussion on the
 [reddit page][] of this project. Also, follow me on twitter,
 [@sharat87](twitter).
@@ -404,6 +424,7 @@ Any comments/suggestions/feedback welcome. Please join the discussion on the
 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting
 [autoenv]: https://github.com/kennethreitz/autoenv
 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
+[cram]: https://bitheap.org/cram/
 [issue]: https://github.com/sharat87/antigen/issues
 [license]: http://mit.sharats.me
 [reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/
...	...	@@ -385,16 +385,36 @@ Defaults to `$HOME/.antigen`.
385	385	were used previously but are now removed. Please use `ADOTDIR` instead, as
386	386	mentioned above.
387	387
	388	+## Running the tests
	389	+
	390	+All the tests are in the `tests` folder and are run using the [cram]() test
	391	+system. Once you have cram installed, you can run the tests as
	392	+
	393	+ make
	394	+
	395	+or
	396	+
	397	+ make tests
	398	+
	399	+If you are making a feature addition, I'd really appreciate if you can add a
	400	+test for your feature. Even if you can add a test for an existing feature, that
	401	+would be great as the tests are currently seriously lagging behind the full
	402	+functionality of antigen.
	403	+
388	404	## Notes on writing plugins
389	405
390	406	> TBD
391	407
392	408	## Meta
393	409
394		-Project is licensed with the [MIT License][license]. To contribute, just fork,
	410	+### Helping out
	411	+
	412	+Antigen is licensed with the [MIT License][license]. To contribute, just fork,
395	413	make changes and send a pull request. If its a rather long/complicated change,
396	414	please consider opening an [issue][] first so we can discuss it out.
397	415
	416	+### Feedback please
	417	+
398	418	Any comments/suggestions/feedback welcome. Please join the discussion on the
399	419	[reddit page][] of this project. Also, follow me on twitter,
400	420	[@sharat87](twitter).
...	...	@@ -404,6 +424,7 @@ Any comments/suggestions/feedback welcome. Please join the discussion on the
404	424	[syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting
405	425	[autoenv]: https://github.com/kennethreitz/autoenv
406	426	[oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
	427	+[cram]: https://bitheap.org/cram/
407	428	[issue]: https://github.com/sharat87/antigen/issues
408	429	[license]: http://mit.sharats.me
409	430	[reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/