Skip to content

Commit 494d060

Browse files
committed
Reflect packaging changes
1 parent 0208c21 commit 494d060

2 files changed

Lines changed: 14 additions & 21 deletions

File tree

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,15 @@ workloads that require strong latency and operational robustness outcomes.
2121

2222
### Installation
2323

24-
LMDB isn't packaged with LmdbJava, so use your operating system's package manager to install it.
25-
26-
- Ubuntu
27-
```bash
28-
apt-get install liblmdb-dev
29-
```
30-
- Arch Linux
31-
```bash
32-
pacman -S lmdb
33-
```
34-
- RHEL / Fedora / CentOS
35-
```bash
36-
yum install lmdb-devel
37-
```
38-
- OSX
39-
```bash
40-
brew install lmdb
41-
```
24+
Windows, Linux and OS X users can simply add the LmdbJava JAR to their classpath
25+
and start using the LmdbJava API (we bundle the LMDB libraries inside the JAR).
26+
If you prefer to use a shared system library, set the `lmdbjava.disable.extract`
27+
[Library](https://github.com/lmdbjava/lmdbjava/tree/master/src/main/java/org/lmdbjava/Library.java) property to `true`.
28+
29+
Other operating systems will need to install the LMDB system library separately.
30+
The standard operating system package manager will likely work, but if you'd
31+
rather a up-to-date, tested, better-supported integration, try adapting the
32+
[LmdbJava Native](https://github.com/lmdbjava/native) cross-compile targets.
4233

4334
### Usage
4435

src/test/java/org/lmdbjava/TutorialTest.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,11 @@
4949
* <p>
5050
* This short tutorial will walk you through using LmdbJava step-by-step.
5151
* <p>
52-
* To complete this tutorial you will need to have installed the LMDB shared
53-
* library on your system. It isn't packaged with LmdbJava, so use your
54-
* operating system's package manager to install it.
52+
* If you are using a 64-bit Windows, Linux or OS X machine, you can simply run
53+
* this tutorial by adding the LmdbJava JAR to your classpath. It includes the
54+
* required system libraries. If you are using another 64-bit platform, you'll
55+
* need to install the LMDB system library yourself. 32-bit platforms are not
56+
* supported.
5557
*/
5658
public class TutorialTest {
5759

0 commit comments

Comments
 (0)