tlevine
/
urchin
1
0
Fork 0
Code Issues 5 Pull Requests 1 Packages Projects Releases Wiki Activity

docs for simple thing

This commit is contained in:
Thomas Levine 2012-10-08 10:24:32 -04:00
parent 8353a54df4
commit f8d345c826
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
readme.md
View File

@ -46,15 +46,13 @@ and directories have special meanings.
teardown teardown
Directories are processed in a depth-first order. When a particular directory Directories are processed in a depth-first order. When a particular directory
is processed, `setup` is run before everything else in the directory, including is processed, `setup` is sourced before everything else in the directory, including
subdirectories. Use `urchin_export`, which works like `export`, to set variables subdirectories. Set variables in the setup function t make them available to other
in the setup function and make them available to other files in the same files in the same directory.
directory.
`teardown` is run after everything else in the directory. The "everything else" `teardown` is run after everything else in the directory.
actually only includes files whose names contain "test". The test passes if the
file exits 0; otherwise, it fails.
Files are only run if they are executable, and files beginning with `.` are Files are only run if they are executable, and files beginning with `.` are
ignored. Thus, fixtures and libraries can be included ignored. Thus, fixtures and libraries can be included sloppily within the test
sloppily within the test directory tree. directory tree. The test passes if the file exits 0; otherwise, it fails.