Add READMEHEADmaster

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f88417d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+Unix tools testing
+==================
+
+This repo was created to contain some simple functional tests for unix tools
+implementations (mostly for testing sbase[0]).
+
+
+Run the tests
+-------------
+
+The "./runalltests" shell script runs all files ending with ".test". Those
+files are shell scripts themselves which expect the binaries to test to
+be in the parent directory.
+
+To add more tests, simply follow the basic example in "dirname.test"
+and preferrably add one "{unix-tool-to-test}.test" file for each tool
+you want to write tests for.
+
+[0] https://core.suckless.org/sbase/