summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKonstantinos Sideris <sideris.konstantin@gmail.com>2017-07-29 12:23:27 +0300
committerKonstantinos Sideris <sideris.konstantin@gmail.com>2017-07-30 14:30:55 +0300
commitbda856d7ae3d7ad1b24637e0741326525e3503ce (patch)
tree5f5413fcb2fc5e2e99aef32ab041c0553cfcd946 /README.md
parent8d05073547d02e105712713de39e8359980812c2 (diff)
Update readme and travis for lmdb
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 27 insertions, 12 deletions
diff --git a/README.md b/README.md
index 4616cabf..f579cd94 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,13 @@ but you can of course receive and send messages in the rooms that you are a memb
#### Arch Linux
```bash
-$ pacaur -S nheko-git
+pacaur -S nheko-git
```
#### Gentoo Linux
```bash
-$ sudo layman -a matrix
-$ sudo emerge -a nheko
+sudo layman -a matrix
+sudo emerge -a nheko
```
#### Windows
@@ -33,6 +33,7 @@ You can find a NSIS installer [here](https://ci.appveyor.com/project/mujx/nheko/
- Qt5 (5.7 or greater). Qt 5.7 adds support for color font rendering with
Freetype, which is essential to properly support emoji.
- CMake 3.1 or greater.
+- [LMDB](https://symas.com/lightning-memory-mapped-database/).
- A compiler that supports C++11.
- Clang 3.3 (or greater).
- GCC 4.8 (or greater).
@@ -40,29 +41,29 @@ You can find a NSIS installer [here](https://ci.appveyor.com/project/mujx/nheko/
##### Arch Linux
```bash
-$ sudo pacman -S qt5-base qt5-tools cmake gcc fontconfig
+sudo pacman -S qt5-base qt5-tools cmake gcc fontconfig lmdb
```
##### Gentoo Linux
```bash
-$ sudo emerge -a ">=dev-qt/qtgui-5.7.1" media-libs/fontconfig
+sudo emerge -a ">=dev-qt/qtgui-5.7.1" media-libs/fontconfig
```
-##### Ubuntu 14.04
+##### Ubuntu (e.g 14.04)
```bash
-$ sudo add-apt-repository ppa:beineri/opt-qt58-trusty
-$ sudo add-apt-repository ppa:george-edison55/cmake-3.x
-$ sudo apt-get update
-$ sudo apt-get install qt58base qt58tools cmake
+sudo add-apt-repository ppa:beineri/opt-qt58-trusty
+sudo add-apt-repository ppa:george-edison55/cmake-3.x
+sudo apt-get update
+sudo apt-get install qt58base qt58tools cmake liblmdb-dev
```
##### OSX (Xcode 7 or later)
```bash
-$ brew update
-$ brew install qt5
+brew update
+brew install qt5 lmdb
```
N.B. you will need to pass `-DCMAKE_PREFIX_PATH=/usr/local/opt/qt5`
@@ -70,6 +71,20 @@ to cmake to point it at your qt5 install (tweaking the path as needed)
### Building
+Clone the repo with its submodules
+
+```bash
+git clone --recursive https://github.com/mujx/nheko
+```
+or
+```bash
+git clone https://github.com/mujx/nheko
+cd nheko
+git submodule update --init
+```
+
+and then use the following
+
```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug.
make -C build