summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2018-10-03 15:26:00 +0200
committerChristian Poessinger <christian@poessinger.com>2018-10-03 15:26:00 +0200
commit8e1989920d1db4c0b1d4fceb188292ed64894fd2 (patch)
tree997cb4ef07f1b18b634e4c312e804e43d94019a5 /README.md
parent6bf96b2085fe254ba467d1d24f9b1621956c6f73 (diff)
downloadvyos-documentation-8e1989920d1db4c0b1d4fceb188292ed64894fd2.tar.gz
vyos-documentation-8e1989920d1db4c0b1d4fceb188292ed64894fd2.zip
Add README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..ca18e5d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+This is a playground for a new VyOS documentation starting for VyOS 1.2 (Crux)
+release.
+
+To build the manual run the following commands inside the `docs` folder:
+
+* `make html` for a HTML manual
+* `make latexpdf` for a LaTeX rendered PDF