Update README.md
authorHermet Park <chuneon.park@samsung.com>
Thu, 18 Feb 2021 08:15:26 +0000 (17:15 +0900)
committerGitHub <noreply@github.com>
Thu, 18 Feb 2021 08:15:26 +0000 (17:15 +0900)
added basic build guide.

README.md

index 613300701633127553da7f3002b825e7e569f686..fbee0632c15019efd43c498e0e1c5e48d4e99223 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# rive-tizen
+# Rive-Tizen
+## Build Rive-Tizen
+### 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
+```