updated READE file. 18/199818/1
authorHermet Park <hermetpark@gmail.com>
Mon, 11 Feb 2019 12:17:27 +0000 (21:17 +0900)
committerHermet Park <hermetpark@gmail.com>
Thu, 14 Feb 2019 23:43:18 +0000 (08:43 +0900)
Change-Id: Ic668f95534504d1b221391beaff6b3b1b0494b23

README.md [moved from README.txt with 86% similarity]

similarity index 86%
rename from README.txt
rename to README.md
index dce83ba..832e8fe 100644 (file)
+++ b/README.md
@@ -1,5 +1,8 @@
-BUILD INSTRUCTIONS
-==================
+# rlottie
+A platform independent standalone library that plays Lottie Animation.
+
+## BUILD INSTRUCTIONS
+
 1. install meson build system. ( follow instruction in this link http://mesonbuild.com/Getting-meson.html )
 2. install ninja build tool    (https://ninja-build.org/)
 3. invoke meson build/  or meson -Dexample=true build/
@@ -7,20 +10,20 @@ BUILD INSTRUCTIONS
 
 NOTE: run meson configure to see all the build options
 
-BUILD EXAMPLES
-==============
+## BUILD EXAMPLES
+
 1. meson configure -Dexample=true
 2. ninja
 3. to run examples invoke ./build/example/demo, etc.
 
-RUN TESTS
-=========
+## RUN TESTS
+
 1. meson configure -Dtest=true
 2. ninja
 3. invoke testsuites as ./build/test/animationTestSuite and ./build/test/vectorTestSuite
 
-BUILD WITH CMAKE
-================
+## BUILD WITH CMAKE
+
 librlottie can also be built using the cmake build system.
 
 1. install cmake.  (Follow instructions at https://cmake.org/download/)
@@ -31,4 +34,3 @@ librlottie can also be built using the cmake build system.
 
 To install to a different prefix, specify it when running cmake, e.g.:
  cmake -DCMAKE_INSTALL_PREFIX:PATH=~/Build -DLIB_INSTALL_DIR=~/Build/lib ..
-