summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..d02557393
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+vyos-smoketest
+==============
+
+This is a set of scripts and test data for sanity checking VyOS builds.
+
+The main entry point is /usr/bin/vyos-smoketest
+
+It will try to check for common things that break such as kernel modules not loading,
+and print a test report.
+
+It also comes with a huge reference config that has almost every feature set.