fix doc and sample apps links
link to LICENSE, too
minor textual fixes
# 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. If you want to use Vespa
-you can go to the
-[quick start guide](http://yahoo.github.io/vespa/vespa-quick-start.html), or find the full
-documentation and other resources at http://yahoo.github.io/vespa/.
+This README describes how to build and develop the Vespa engine. To get started, read the
+[quick start](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/vespa-quick-start.html), or find the full
+documentation at https://git.corp.yahoo.com/pages/vespa/documentation/.
-## Getting started developing
+Code licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for terms.
-### Setting up local git config
+## Get started developing
+### Set up local git config
git config --global user.name "John Doe"
git config --global user.email johndoe@host.com
-### Setting up build environment
-
+### Set up build environment
C++ building is supported on CentOS 7.
#### Install required build dependencies
-
sudo yum -y install epel-release centos-release-scl yum-utils
sudo yum-config-manager --add-repo https://copr.fedorainfracloud.org/coprs/g/vespa/vespa/repo/epel-7/group_vespa-vespa-epel-7.repo
sudo yum -y install devtoolset-4-gcc-c++ devtoolset-4-libatomic-devel \
Judy-devel cmake3 ccache lz4-devel zlib-devel maven libicu-devel llvm-devel \
llvm-static java-1.8.0-openjdk-devel openssl-devel rpm-build make \
vespa-boost-devel vespa-libtorrent-devel vespa-zookeeper-c-client-devel vespa-cppunit-devel
-
-or use our prebuilt docker image
+or use the prebuilt docker image
# TODO: Add docker command
-### Building Java modules
-
+### Build Java modules
Java modules can be built on any environment having Java and Maven:
sh bootstrap.sh
mvn install
-### Building C++ modules
-
+### Build C++ modules
source /opt/rh/devtoolset-4/enable
sh bootstrap.sh full
cmake .
@@ -49,15 +43,13 @@ Java modules can be built on any environment having Java and Maven:
make test
### Create RPM packages
-
sh dist.sh VERSION && rpmbuild -ba ~/rpmbuild/SPECS/vespa-VERSION.spec
-## Running Vespa on a local machine
-
-See [node-admin/README.md](node-admin/README.md)
-
-Code licensed under the Apache 2.0 license. See LICENSE file for terms.
-## Documenting your features
+## Run Vespa on a local machine
+A basic, single-node install if found in the
+[quick start](https://git.corp.yahoo.com/pages/vespa/documentation/documentation/vespa-quick-start.html).
+For multi-node and using Node Admin, read [node-admin/README.md](node-admin/README.md).
+## Write documentation
See [README-documentation.md](README-documentation.md).
