aboutsummaryrefslogtreecommitdiff
path: root/content/docs/documentation.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/docs/documentation.md')
-rw-r--r--content/docs/documentation.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/content/docs/documentation.md b/content/docs/documentation.md
new file mode 100644
index 0000000..f48e03c
--- /dev/null
+++ b/content/docs/documentation.md
@@ -0,0 +1,41 @@
+---
+title: "Documentation"
+date: 2019-06-22
+type: page
+draft: false
+---
+
+# Getting started
+
+* [Requirements](/requirements/)
+* [Download Ouroboros](/download/)
+* [Installing Ouroboros](/install/)
+* [Compilation options](/compopt/)
+
+# User tutorials
+
+These tutorials will be kept up-to-date for the latest version of
+Ouroboros. Check the version that is installed on your system using:
+
+```
+$ irmd --version
+```
+
+The output shown in the tutorials uses a [*debug*](/compopt) build
+of Ouroboros, with FUSE installed and IPCP\_FLOW\_STATS enabled to show
+some additional details of what is happening.
+
+* [Tutorial 1: Local test](/tutorial-1/)
+* [Tutorial 2: Adding a layer](/tutorial-2/)
+* [Tutorial 3: IPCP statistics](/tutorial-3/)
+* [Tutorial 4: Connecting two machines over Ethernet](/tutorial-4/)
+
+# Developer tutorials
+
+* [Developer tutorial 1: Writing your first Ouroboros C program](/dev-tut-1/)
+
+# Extra info
+
+* [Manual pages](/manuals/)
+* [Frequently Asked Questions (FAQ)](/faq/)
+* [Performance tests](/performance/)