From a6162d712c4f40baa8acbd420e62cc76af1e3b44 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Tue, 23 Apr 2013 08:30:40 -0300 Subject: [PATCH] Move installation and usage up on README.md --- README.md | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 00eed3b..6446a2b 100644 --- a/README.md +++ b/README.md @@ -21,36 +21,13 @@ sudo dpkg -i /tmp/vagrant.deb ``` -## What is currently supported? - -Pretty much everything you need from Vagrant: - -* Vagrant's `up`, `halt`, `reload`, `destroy`, `ssh` and `package` commands (box packaging is kind of experimental) -* Shared folders -* Provisioning -* Setting container's host name -* Port forwarding - -*Please refer to the [closed issues](https://github.com/fgrehm/vagrant-lxc/issues?labels=&milestone=&page=1&state=closed) -and the [changelog](CHANGELOG.md) for most up to date information.* - - -## Current limitations - -* Does not detect forwarded ports collision, right now you are responsible for taking care of that -* A hell lot of `sudo`s (this will probably be like this until [user namespaces](http://s3hh.wordpress.com/2013/02/12/user-namespaces-lxc-meeting/) are supported) -* [Does not tell you if dependencies are not met](https://github.com/fgrehm/vagrant-lxc/issues/11) - (will probably just throw up some random error) -* + bunch of other [core features](https://github.com/fgrehm/vagrant-lxc/issues?labels=core&milestone=&page=1&state=open) - and some known [bugs](https://github.com/fgrehm/vagrant-lxc/issues?labels=bug&page=1&state=open) - - ## Installation ``` vagrant plugin install vagrant-lxc ``` + ## Usage After installing, add a [base box](#available-boxes) using any name you want, for example: @@ -112,6 +89,30 @@ NFS shared folders are not supported and will behave as a "normal" shared folder so we can share the same Vagrantfile with VBox environments. +## What is currently supported? + +Pretty much everything you need from Vagrant: + +* Vagrant's `up`, `halt`, `reload`, `destroy`, `ssh` and `package` commands (box packaging is kind of experimental) +* Shared folders +* Provisioning +* Setting container's host name +* Port forwarding + +*Please refer to the [closed issues](https://github.com/fgrehm/vagrant-lxc/issues?labels=&milestone=&page=1&state=closed) +and the [changelog](CHANGELOG.md) for most up to date information.* + + +## Current limitations + +* Does not detect forwarded ports collision, right now you are responsible for taking care of that +* A hell lot of `sudo`s (this will probably be like this until [user namespaces](http://s3hh.wordpress.com/2013/02/12/user-namespaces-lxc-meeting/) are supported) +* [Does not tell you if dependencies are not met](https://github.com/fgrehm/vagrant-lxc/issues/11) + (will probably just throw up some random error) +* + bunch of other [core features](https://github.com/fgrehm/vagrant-lxc/issues?labels=core&milestone=&page=1&state=open) + and some known [bugs](https://github.com/fgrehm/vagrant-lxc/issues?labels=bug&page=1&state=open) + + ## Development If want to develop from your physical machine, just sing that same old song: