summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Adamansky <adamansky@gmail.com>2015-03-18 15:49:44 +0600
committerAnton Adamansky <adamansky@gmail.com>2015-03-18 15:49:44 +0600
commit8f9b44d1c7c77d0dfb385fa2be95db82c2263f8b (patch)
tree8b3d0533059a07a80b24ba76f70a2b0f4bf0efaa
parent47eab0d334f627440876b0a61a76a6b1e9e61ea4 (diff)
downloadejdb-8f9b44d1c7c77d0dfb385fa2be95db82c2263f8b.tar.gz
ejdb-8f9b44d1c7c77d0dfb385fa2be95db82c2263f8b.tar.bz2
ejdb-8f9b44d1c7c77d0dfb385fa2be95db82c2263f8b.zip
INSTALL docs
-rw-r--r--INSTALL107
1 files changed, 106 insertions, 1 deletions
diff --git a/INSTALL b/INSTALL
index e4d7d18..aeed553 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,2 +1,107 @@
-See http://ejdb.org
+Building
+========
+Prerequisites
+-------------
+
+ * git
+ * GNU make
+ * cmake >= 2.8.12
+ * gcc >= 4.7 or clang >= 3.4 C compiller
+ * zlib-dev
+
+Make
+----
+
+```sh
+git clone https://github.com/Softmotions/ejdb.git
+cd ejdb
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release ../
+make
+make install
+# Or you can create tgz package:
+make package
+```
+
+### CMake basic build(-D) options
+
+```
+// Build ejdb sample projects
+BUILD_SAMPLES:BOOL=ON
+
+// Build shared libraries
+BUILD_SHARED_LIBS:BOOL=ON
+
+// Build test cases
+BUILD_TESTS:BOOL=OFF
+
+// Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo.
+CMAKE_BUILD_TYPE:STRING=Release
+
+// Install path prefix, prepended onto install directories.
+CMAKE_INSTALL_PREFIX:PATH=/usr/local
+
+// Enable PPA package build
+ENABLE_PPA:BOOL=OFF
+
+// Build .deb instalation packages
+PACKAGE_DEB:BOOL=OFF
+
+// Build .tgz package archive
+PACKAGE_TGZ:BOOL=ON
+
+// Upload debian packages to the launchpad ppa repository
+UPLOAD_PPA:BOOL=OFF
+```
+
+### Building Windows libs
+
+You need to checkout the [MXE cross build environment](http://mxe.cc)
+Then create/edit MXE settings file:
+
+```sh
+cd <mxe checkout dir>
+nano ./settings.mk
+```
+
+Save the following content in `settings.mk`:
+
+```
+JOBS := 1
+MXE_TARGETS := x86_64-w64-mingw32.static i686-w64-mingw32.static
+LOCAL_PKG_LIST := winpthreads pcre zlib lzo bzip2 cunit
+.DEFAULT local-pkg-list:
+local-pkg-list: $(LOCAL_PKG_LIST)
+```
+
+Build MXE packages:
+
+```sh
+ cd <mxe checkout dir>
+ make
+```
+
+Build libejdb windows binaries:
+
+```sh
+export MXE_HOME=<mxe checkout dir>
+cd <ejdb checkout dir>
+mkdir build-win32
+cd build-wind32
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=../win64-tc.cmake ..
+make package
+```
+
+EJDB binary package installation
+===================================
+
+Ubuntu
+------
+
+```sh
+sudo add-apt-repository ppa:adamansky/ejdb
+sudo apt-get update
+sudo apt-get install ejdb ejdb-dbg
+```