add readme

This commit is contained in:
jb-alvarado 2022-05-17 21:29:20 +02:00
parent 48e06665ef
commit fb85b84e61

26
docs/README.md Normal file
View File

@ -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