README: add requirements
authorMyungJoo Ham <myungjoo.ham@gmail.com>
Thu, 28 Nov 2019 13:49:20 +0000 (22:49 +0900)
committerGitHub <noreply@github.com>
Thu, 28 Nov 2019 13:49:20 +0000 (22:49 +0900)
Added a few requirements

README.md

index db6461400035868457b0de91b65828a49639010b..a631ee482183b74026b9132a603494aa1d101ce4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,3 +3,13 @@ Remote source nodes for NNStreamer pipelines without GStreamer dependencies
 
 Developers may provide stream inputs to NNStreamer pipelines from remote nodes with nnstreamer-edge.
 NNStreamer-edge is designed not to depend on GStreamer and targets to be adopted by general RTOS as well.
+
+## Requirements
+- This should not depend on glib, gstreamer, or nnstreamer
+- This should not depend on other heavy-weighted libraries.
+- This should be compatible not only with Linux, but also with RTOS and other OS; thus, this should try to stick with C basic libraries and POSIX libraries.
+    - However, it may leave empty spaces that can be filled with "wrapper/plugin" for the portability. E.g., I may get too lazy to write communication layers; then, I'll leave it to the users to write down their own communication plugins.
+    - This should not rely on Tizen, either. However, Tizen-RT might be considered as the primary target.
+- Communication Layers includes:
+    - Primary Targets: TCP, UDP, User Plugins.
+    - Secondary Targets: Flatbuffers