From fb85b84e617b42bec307a6b79dc4fd8c7638dead Mon Sep 17 00:00:00 2001
From: jb-alvarado <jb@pixelcrusher.de>
Date: Tue, 17 May 2022 21:29:20 +0200
Subject: [PATCH] add readme

---
 docs/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..272d85c6
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,26 @@
+**ffplayout-engine Documentation**
+================
+
+### **[For Developer](/docs/developer.md)**
+
+Learn how to setup a developer environment and to cross compile for different platforms.
+
+### **[Folder Mode](/docs/folder_mode.md)**
+
+Learn more about playing the content of a folder.
+
+### **[Live Ingest](/docs/live_ingest.md)**
+
+Using live ingest to inject a live stream.
+
+### **[Output Modes](/docs/output.md)**
+
+The different output modes.
+
+### **[Preview Stream](/docs/preview_stream.md)**
+
+Setup and use a preview stream.
+
+### **[Remove Sources](/docs/remote_source.md)**
+
+Use of remote sources, like https://example.org/video.mp4