From a7a1f40d5f42eecb48cb2c8a920a54a7c18b3ba9 Mon Sep 17 00:00:00 2001 From: gichan Date: Wed, 29 Mar 2023 15:41:13 +0900 Subject: [PATCH] [README] Add quick start guide Add quick start guide - install nnstreamer-edge via ppa - build and run unit tests Signed-off-by: gichan --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 44d1ccd..c9044e7 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,43 @@ If your system can afford running nnstreamer (gstreamer), don't use nnstreamer-e - 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. + - Primary Targets: TCP, User Plugins. - Secondary Targets: Flatbuffers +# Quick start guide for NNStreamer-edge (Ubuntu 20.04 LTS or 22.04 LTS) + - Note: This simple guide explains how to use NNStreamer-edge on the Ubuntu, but NNStreamer-edge is also available on Tizen, Android and TizenRT. +## Install via PPA +### Download nnstreamer-edge +``` +$ sudo add-apt-repository ppa:nnstreamer/ppa +$ sudo apt-get install nnstreamer-edge +# Download nnstreamer for sample application +(optional) $ sudo apt-get install nnstreamer +``` +### Run nnstreamer and nnstreamer-edge sample application + - See pub/sub example: [Link](https://nnstreamer.github.io/tutorial3_pubsub_mqtt.html) + - See query example: [Link](https://nnstreamer.github.io/tutorial4_query.html) + +## How to build (Ubuntu 20.04 LTS or 22.04 LTS) + +### Download prerequisite +``` +$ sudo apt-get install cmake systemctl build-essential pkg-config mosquitto-dev libmosquitto-dev libgtest-dev libgmock-dev +# Run MQTT broker +$ sudo systemctl start mosquitto +``` + +### Build and Run test +``` +# cd $NNST_EDGE_ROOT +$ cmake -B build -DCMAKE_INSTALL_PREFIX=/usr -DENABLE_TEST=ON -DMQTT_SUPPORT=ON +$ make -C build install + +# Run test +$ cd /usr/bin +$ ./unittest_nnstreamer-edge +$ ./unittest_nnstreamer-edge-mqtt +``` + ## License - Apache 2.0 -- 2.34.1