update doc and README.md; instruction for the test.

WMD-group · Mar 10, 2020 · dbbae4c · dbbae4c
1 parent 536e807
commit dbbae4c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,12 @@ julia> using Pkg
 julia> Pkg.add(PackageSpec(url="https://github.com/WMD-group/CarrierCapture.jl.git"))
 ```
 
+To run the unit tests for the package, use the `Pkg.test` function. 
+
+```julia
+julia> Pkg.test("CarrierCapture")
+```
+
 ## Development
 
 The project is hosted on [Github](https://github.com/WMD-group/carriercapture).

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -22,6 +22,11 @@ julia> using Pkg
 julia> Pkg.add(PackageSpec(url="https://github.com/WMD-group/CarrierCapture.jl.git"))
 ```
 
+To run the unit tests for the package, use the `Pkg.test` function. 
+
+```julia
+julia> Pkg.test("CarrierCapture")
+```
 
 ## Development