Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,35 @@ The MerkOrCore API and command line interface can be used to query this data

## Getting started
*Note that MerkOrCore is developed and tested under Mac OS X only, please report any problems with other platforms!*

### Java
Download the Java JDK from there: http://www.oracle.com/technetwork/java/javase/downloads/index.html

### Redis
The MerkOr data is stored in Redis format. Redis is available at http://redis.io (installation instructions under http://redis.io/download).
The Redis data is included in this package as `dump.rdb.bz2`.
The MerkOr data is stored in Redis format. The Redis data is included in this package as `dump.rdb.bz2`.

Redis is available at http://redis.io (installation instructions under http://redis.io/download). Homebrew users can install with `$ brew install redis`.

Extract `dump.rdb.bz2` using the terminal or double click the file in Finder (OSX). To load the database file you add `redis.config` to your projects root with the following content:

```
# The filename where to dump the DB
dbfilename dump.rdb

# The working directory.
#
# The DB will be written inside this directory, with the filename specified
# above using the 'dbfilename' configuration directive.
#
# Also the Append Only File will be created inside this directory.
#
# Note that you must specify a directory here, not a file name.
dir /path/to/merkor/
```
Run the Redis server with the following command in the project root directory:

`redis-server ./redis.config`

After you have installed Redis, unpacked and loaded the MerkOr data, you can try it out directly in Redis command line interface, (in the Redis directory start `src/redis-cli`), for example:

redis 127.0.0.1:6379> smembers merkor_is_lemma_lampi
Expand All @@ -56,6 +82,7 @@ After you have installed Redis, unpacked and loaded the MerkOr data, you can try
3) "wordclass"
4) "noun"


This assures you that the MerkOr data is loaded but you don't have to study redis-cli to use the MerkOrCore API. For those interested in inspecting the data directly, for example with redis-cli, the structure of the Redis data is shown in the file `merkor_redis_structure.txt`.

### MerkOrCore API
Expand Down