Skip to content
This repository
Newer
Older
100644 71 lines (34 sloc) 2.317 kb
8ab83e0d » ctrabold
2013-02-05 Improve formating
1 # Requirements
a6e1c528 » sammcj
2012-10-04 Update doc/requirements.md
2
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
3 Veewee has a few requirements that must be met before you're able to use Veewee.
4
5
6 ## Virtualization Providers
7
8 You'll need to install at least one of the supported VM providers (see [Providers](providers.md) doc for details). If you're not sure which provider to use, a common choice is [VirtualBox](http://www.virtualbox.org/) since it's free, portable, and supported by Vagrant.
ffd5371b » ctrabold
2013-02-05 Write introduction
9
10
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
11 ## Development Libraries
a6e1c528 » sammcj
2012-10-04 Update doc/requirements.md
12
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
13 Veewee is written in Ruby. In order to use Veewee you need Ruby installed as well as some header files
14 in order to compile native extensions that come as dependencies. If you already have experiences with Ruby this should be very straightforward.
15
16
17 ### For Linux
18
19 On Linux, you may need these packages in order to build native rubygems:
8ab83e0d » ctrabold
2013-02-05 Improve formating
20
21 libxslt1-dev
22 libxml2-dev
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
23 zlib1g-dev # or build-essential
24
25
26 ### For Mac OS X
27
28 On Macs, either install `Xcode` or use [homebrew](http://mxcl.github.io/homebrew/) to install `apple-gcc42` or `build-essential`.
29
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
30
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
31 ### For Windows
41b3d05e » dgfitch
2013-04-08 Extend documentation and tweak Gemfile for windows use
32
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
33 On Windows, you will need to install:
34
35 * Ruby devkit
36 * msysgit
a6a9c1d2 » Mark Leighton Fisher
2013-08-13 Fixed doc/requirements.md to include PowerShell and PowerShell Commun…
37 * PowerShell (if on XP or Vista)
38 * PowerShell Community Extensions
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
39 * And you may need to add VirtualBox to your `PATH`, usually installed to `C:\Program Files\Oracle\VirtualBox`.
41b3d05e » dgfitch
2013-04-08 Extend documentation and tweak Gemfile for windows use
40
0d459c53 » ctrabold
2013-02-05 Fix wording
41
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
42 ## Ruby Environment
43
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
44 It is highly recommended that you use either `rvm` or `rbenv` to manage your ruby versions.
45
46
47 ### Option 1: RVM
48
49 [RVM](https://rvm.io/) is Veewee's prefered ruby version manager.
50
51 RVM will allow Veewee to install it's own [gemset](https://rvm.io/gemsets/basics/) and configure it's own ruby version - which keeps Veewee and it's dependancies completely separate from your other projects. Please see https://rvm.io/gemsets/basics/ for details if you are new to the concept of 'gemsets'.
52
53
54 ##### Installing RVM
55
56 Please see the [RVM install documentation](https://rvm.io/rvm/install) for up-to-date installation instructions.
57
58
59 ### Option 2: rbenv
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
60
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
61 [rbenv](https://github.com/sstephenson/rbenv) is another popular ruby version manager that you can use as an alternative to RVM.
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
62
63
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
64 ##### Installing rbenv
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
65
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
66 Please see the [rbenv README]( https://github.com/sstephenson/rbenv/#installation) for up-to-date installation instructions.
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
67
68
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
69 ## Up Next
acaf24dc » ctrabold
2013-02-05 Split installation & requirements instructions
70
43cd8204 » benlinton
2013-04-14 Overhaul all documentation
71 Ok, now that we have cover all the requirements, you can move on with [installing Veewee](installation.md).
Something went wrong with that request. Please try again.