Add README
For CI build ${datadir} is expanded to /usr/local/share to which the
dependent files and parser are exported, so don't add the prefix
option.
For recipe build ${datadir} is expanded to /usr/share to which
the dependent files and parser are exported, so don't add the prefix
option.
For local build need to pass the prefix option as the ${datadir}
expands to /usr/local/share by default but the required yaml and
parser exist at /usr/share location in SDK.
Change-Id: Ib0d776fe9b03b862c6f8dff5339fbde49d71bd5d
Signed-off-by: Marri Devender Rao <devenrao@in.ibm.com>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28e8d67
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+## To Build
+```
+To build this package, do the following steps:
+
+ 1. ./bootstrap.sh
+ 2. ./configure ${CONFIGURE_FLAGS} --prefix=/usr
+ 3. make
+
+To full clean the repository again run `./bootstrap.sh clean`.
+```
+
+```
+For local build, pass --prefix=/usr option to the configure script
+to let the Makefile use /usr/share value over /usr/local/share for ${datadir}
+variable. The error yaml files and elog parser are stored in /usr/share
+location in the SDK.
+```
+
+```
+For CI build, ${datadir} is expanded to /usr/local/share to which the
+dependent files and parser are exported, so don't add the prefix option.
+```
+
+```
+For recipe build, ${datadir} is expanded to /usr/share to which the
+dependent files and parser are exported, so don't add the prefix option.
+```