cc775daf78d1d30d1ce7f8c0dfb416b5bdd49455

Author
Michael Aquilina <michaelaquilina@gmail.com>
Committer
Michael Aquilina <michaelaquilina@gmail.com>
Date

Message

Add section about running tests to README

Diff

 1diff --git a/README.rst b/README.rst
 2index d1567cc8e360d6bb061299b1cc2183589bc5f667..6d2d891fa6bd6cfa4aa52f95dd413ab5306a5ee8 100644
 3--- a/README.rst
 4+++ b/README.rst
 5@@ -13,6 +13,7 @@ virtualenvs automatically as you move between directories.
 6 * Commands_
 7 * Options_
 8 * `Security Warnings`_
 9+* `Running Tests`_
10 
11 
12 How it Works
13@@ -225,6 +226,26 @@ These are security measures that prevents other, potentially malicious
14 users, from switching you to a virtual environment you did not want to
15 switch to.
16 
17+Running Tests
18+-------------
19+
20+Install `zunit <https://zunit.xyz/>`__. Run ``zunit`` in the root
21+directory of the repo.
22+
23+::
24+
25+    $ zunit
26+    Launching ZUnit
27+    ZUnit: 0.8.2
28+    ZSH:   zsh 5.3.1 (x86_64-suse-linux-gnu)
29+
30+    ✔ ysu message correct output
31+    ✔ ysu global message correct output
32+    ✔ ysu git message correct output
33+
34+NOTE: It is required that you use a minimum zunit version of 0.8.2
35+
36+
37 .. _Zplug: https://github.com/zplug/zplug
38 
39 .. _Antigen: https://github.com/zsh-users/antigen