Skip to content
Browse files

Integrate install.md & improve overall structure

  • Loading branch information...
1 parent 57f1b48 commit 88c35c75ac2152d543ed70a2f47ed9d903292286 @ctrabold ctrabold committed Feb 3, 2013
Showing with 23 additions and 7 deletions.
  1. +23 −7 doc/installation.md
View
30 doc/installation.md
@@ -1,4 +1,9 @@
-This needs to be bulked out more, but for now, here is a basic guide to installing Veewee from source.
+# Overview
+
+Veewee is a tool to help you building a Virtual Machine from an ISO-file.
+
+
+## Requirements
First, if you are not using RVM, it's recommended that you do so as veewee will install in it's own gemset which keeps veewee and it's dependancies completely separate from your other Ruby gems.
@@ -15,19 +20,30 @@ Now, install Ruby 1.9.2 using RVM:
Ok, now that we have RVM installed, you can now install Veewee.
+
+## Install
+
+These instructions need to be bulked out more, but for now, here is a basic guide to installing Veewee from source.
+
+__as a gem__
+
+ $ gem install veewee
+
+__from source__
+
When you cd into the veewee directory, rvm should automatically read the .rvmrc file and prompt you to verify it - you can do so by pressing Y. This will then create a gemset for veewee.
$ git clone https://github.com/jedi4ever/veewee.git
$ cd veewee
$ gem install bundler
$ bundle install
-_Note: testing kvm while running from source git repo_
+### Important:
+
+_Note: testing `kvm` while running from source git repo_
-By default the ``:kvm`` gem group is disabled - this to prevent the installation of ``ruby-libvirt`` on systems that don't need it.
-This is done by the file ``.bundle/config`` .
+By default the `:kvm` gem group is *disabled* to prevent the installation of `ruby-libvirt` on systems that don't need it. This is done by the file `.bundle/config`.
-If you do need it, run ``bundle install --without restrictions`` . (restrictions is a dummy name)
-This will change the file ``.bundle/config`` . This files is gitignored by default and should not be included in any commits back.
+If you do need it, run `bundle install --without restrictions` (restrictions is a dummy name). This will change the file `.bundle/config`, which is ignored by Git per default and must not be included in any commits.
-As this is a remembered option, you don't have to specify it everytime. If you want to switch to the default behavior run ``bundle install --without kvm``.
+As this is a remembered option, you don't have to specify it every time. If you want to switch to the default behavior run `bundle install --without kvm` to enable restrictions.

0 comments on commit 88c35c7

Please sign in to comment.
Something went wrong with that request. Please try again.