Publish

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..3004fd323c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,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.