diff options
| author | Yuval Adam <yuv.adm@gmail.com> | 2013-05-13 11:29:47 +0300 |
|---|---|---|
| committer | Yuval Adam <yuv.adm@gmail.com> | 2013-05-13 11:29:47 +0300 |
| commit | 7439ea728fac777596b99ec83da6903010c4c291 (patch) | |
| tree | eaf1ea5d0fb0cb6c9a7ad9654c763393276f2a43 | |
| parent | d478cb50f07f739a28c574e7ef7e1de6529a5d11 (diff) | |
Add usage to README
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -2,3 +2,25 @@ An easy-to-use [Vagrant](http://docs.vagrantup.com/v2/)-based setup for GNU Radio applications. +## Usage + +First, download and install the latest version of Vagrant from [http://downloads.vagrantup.com](http://downloads.vagrantup.com). Do not count on your package manager to deliver the latest version of Vagrant. + +Once Vagrant is set up: + +```bash +$ git clone git://github.com/yuvadm/marconi.git && cd marconi +$ vagrant up +``` + +Initially running `vagrant up` will take a while since Vagrant will need to download the initial virtual machine, and then proceed to install all the dependencies, and compile GNU Radio. After all these steps are through, you should have a fully working GNU Radio environment running on an Ubuntu virtual machine. SSH into the machine with: + +```bash +$ vagrant ssh +``` + +Halt or destroy the instance with: + +```bash +$ vagrant [halt|destroy] +``` |
