packaging: includes rive-tizen header files

[platform/core/uifw/rive-tizen.git] / README.md

diff --git a/README.md b/README.md
index 6133007..1ad2a24 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# rive-tizen
+# Rive-Tizen
+## Build
+### Prerequiste
+Rive-Tizen requires [ThorVG](https://github.com/Samsung/thorvg) to render Rive graphical units.
+Please visit [ThorVG](https://github.com/Samsung/thorvg) and install that library by its guidance.
+
+### Prepare Sub Modules
+Rive-Tizen extends [rive-cpp](https://github.com/rive-app/rive-cpp)  project for exchanging backend rendering engine to Tizen specific.
+Thus, you can immediately clone the rive-cpp project and build it on Rive-Tizen repo.
+```
+git submodule update --init --recursive
+```
+
+### Build Rive-Tizen
+Basically, Rive-Tizen supports [meson](https://mesonbuild.com/) build system.
+
+Install [meson](http://mesonbuild.com/Getting-meson.html) and [ninja](https://ninja-build.org/) if not installed yet.
+
+Run meson to configure Rive-Tizen.
+```
+meson build
+```
+Run ninja to build & install Rive-Tizen
+```
+ninja -C build install
+```