aboutsummaryrefslogtreecommitdiffstats
path: root/vagrant
diff options
context:
space:
mode:
authorGeir Storli <geirst@oath.com>2017-10-06 13:55:40 +0200
committerGeir Storli <geirst@oath.com>2017-10-06 13:55:40 +0200
commit2e78bd9231c7888d8a196d22b93108dd7d170af2 (patch)
treead369be4ed5e62f058378ca9683c307fe477d3e8 /vagrant
parent3e0bf2f6eba466f11dd265690b78e00b9ecf14c9 (diff)
Fix formatting by using headers.
Diffstat (limited to 'vagrant')
-rw-r--r--vagrant/README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/vagrant/README.md b/vagrant/README.md
index 1ca811f982d..b35e0b1ad84 100644
--- a/vagrant/README.md
+++ b/vagrant/README.md
@@ -7,23 +7,25 @@
## Create dev environment
-1. Change working directory to <vespa-source>/vagrant
+#### 1. Change working directory to <vespa-source>/vagrant
+
cd <vespa-source>/vagrant
-1. Install Vagrant VirtualBox Guest Additions plugin
+#### 2. Install Vagrant VirtualBox Guest Additions plugin
This is required for mounting shared folders and get mouse pointer integration and seamless windows in the virtual CentOS desktop.
vagrant plugin install vagrant-vbguest
-1. Start and provision the environment
+#### 3. Start and provision the environment
+
vagrant up
-1. Connect to machine via SSH
+#### 4. Connect to machine via SSH
SSH agent forwarding is enabled to ensure easy interaction with GitHub inside the machine.
vagrant ssh
-1. Checkout vespa source inside virtual machine
+#### 5. Checkout vespa source inside virtual machine
This is needed in order to compile and run tests fast on the local file system inside the virtual machine.
git clone git@github.com:vespa-engine/vespa.git
@@ -37,22 +39,22 @@ Skip these steps if doing development with CLion.
## Build and Develop using CLion
CLion is installed as part of the environment and is recommended for C++ development.
-1. Bootstrap C++ building
+#### 1. Bootstrap C++ building
Go to <vespa-source> directory and execute:
./bootstrap-cpp.sh . .
-1. Start CLion
+#### 2. Start CLion
Open a terminal inside the virtual CentOS desktop and run:
clion
-1. Open the Vespa Project
+#### 3. Open the Vespa Project
Go to *File* -> *Open* and choose <vespa-source>/CMakeLists.txt.
-1. Set compiler threads
+#### 4. Set compiler threads
Go to *File* -> *Settings* -> *Build, Execution, Deployment* -> *CMake*.
Under *Build Options* specify "-j 4" and click *Apply*.
-1. Build all modules
+#### 5. Build all modules
Choose target **all_modules** from the set of build targets and click build.