Add a README.md to explain a few things
Christian Couder committed
Nov 7, 2014 at 23:49 UTC
e211b6543ad522ee48e59e155ae09d9b99c9c8d8
1 file changed
+26
test/README.md
new
+26
@@ -0,0 +1,26 @@
1
+# ipfs whole tests using the [sharness framework](https://github.com/mlafeldt/sharness/)
2
+
3
+## Running all the tests
4
+
5
+Just use `make` in this directory to run all the tests.
6
+
7
+## Running just one test
8
+
9
+You can run only one test script by launching it like a regular shell
10
+script:
11
+
12
+```
13
+$ ./t0010-basic-commands.sh
14
+```
15
+
16
+## Sharness
17
+
18
+When running "make" in this directory for the first time, sharness
19
+will be downloaded from its github repo and installed in a "sharness"
20
+directory.
21
+
22
+Please do not change anything in the "sharness" directory.
23
+
24
+If you really need some changes in sharness, please fork it from
25
+[its cannonical repo](https://github.com/mlafeldt/sharness/) and
26
+send pull requests there.
\ No newline at end of file