x/solar
Code Issues Proposed changes

Merge pull request #175 from zen/master

Browse Source 
fixes #171 - Correcting documentation regarding requirements
This commit is contained in:
Łukasz Oleś 2015-09-24 19:42:29 +02:00
commit 613616a5a4
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,8 +1,29 @@
# Setup development env
[![Build Status](https://travis-ci.org/Mirantis/solar.svg?branch=master)](https://travis-ci.org/Mirantis/solar)
# Requirements
## Supported development platforms
Linux or MacOS
## Additional software
[VirtualBox](https://www.virtualbox.org/wiki/Downloads): 5.x
[Vagrant](http://www.vagrantup.com/downloads.html): 1.7.x
Note: If you are using VirtualBox 5.0 it's worth uncommenting paravirtprovider setting in `vagrant-settings.yaml` for speed improvements:
```bash
paravirtprovider: kvm
```
For details see Customizing `vagrant-settings.yaml` section.
Install [Vagrant](http://www.vagrantup.com/downloads.html).
For automatically installation of VirtualBox Guest Additions you could install
[vagrant plugin](https://github.com/dotless-de/vagrant-vbguest).
# Setup development env
Setup environment:
```bash
cd solar
@ -267,3 +288,8 @@ riak_master_service.connect_list(
For full Riak example, please look at `examples/riak/riaks-template.py`.
Full documentation of individual functions is found in the `solar/template.py` file.
# Customizing vagrant-settings.yaml
Solar is shipped with sane defaults in `vagrant-setting.yaml_defaults`. If you need to adjust them for your needs, e.g. changing resource allocation for VirtualBox machines, you should just compy the file to `vagrant-setting.yaml` and make your modifications.