aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3004fd323c4e06a8a3001a14062b25276f155c4a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# Vespa

Vespa is an engine for low-latency computation over large data sets.
It stores and indexes your data such that queries, selection and processing over the
data can be performed at serving time.

This README describes how to build and develop the Vespa engine.
For user documentation see TODO: Github pages link

## Getting started

### Setting up local git config

    git config --global user.name "John Doe"
    git config --global user.email johndoe@host.com


### Setting up build environment

    sudo yum -y  install epel-release
    # TODO: Install build deps or depend on Build-Require in .spec file?

### Building Java modules

Java modules can be built on any environment having Java and Maven:

    sh bootstrap.sh
    mvn install

### Building C++ modules

C++ building is currently supported on CentOS 7:

TODO: List required build dependencies

    sh bootstrap.sh
    cmake .
    make
    make test

### Create RPM packages

    sh dist.sh VERSION && rpmbuild -ba ~/rpmbuild/SPECS/vespa-VERSION.spec

## Running Vespa on a local machine

* OS X : See [node-admin/README_MAC.md](node-admin/README_MAC.md)
* Linux : See [node-admin/README_LINUX.md](node-admin/README_LINUX.md)


Code licensed under the Apache 2.0 license. See LICENSE file for terms.