Skip to content

Commit

Permalink
[README] Offer simpler Vagrant instructions, using the traditional pr…
Browse files Browse the repository at this point in the history
…ocess
  • Loading branch information
markcjeffrey committed Apr 13, 2016
1 parent c80ca25 commit bcd9f19
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,17 +107,24 @@ You can also follow this Vagrantfile to figure out how to setup zsim on an
Ubuntu system. Note that **zsim will be much slower on a VM** because it relies
on fast context-switching, so we don't recommend this for purposes other than
testing and development. Assuming you have vagrant installed (`sudo apt-get
install vagrant` on Ubuntu or Debian), follow these:

1. Copy `misc/Vagrantfile` from the repo into an empty folder.

2. Run `vagrant up` to set up the base VM and install all dependencies.

3. SSH into the VM with `vagrant ssh`.

4. Inside the VM, you can clone the zsim repo, and build it and use it as usual
(steps 1, 5, and 6 above).

install vagrant` on Ubuntu or Debian), follow these steps:

Copy the Vagrant file to the zsim root folder, boot up and provision the base VM
with all dependencies, then ssh into the VM.
```bash
cp misc/Vagrantfile .
vagrant up
vagrant ssh
```

Vagrant automatically [syncs](https://www.vagrantup.com/docs/synced-folders/)
the zsim root folder of your host machine to `/vagrant/` on the guest machine.
Now that you're in the VM, navigate to that synced folder, and simply build and
use zsim (steps 5 and 6 above).
```bash
cd /vagrant/
scons -j4
```

Notes
-----
Expand Down
2 changes: 0 additions & 2 deletions misc/Vagrantfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,5 @@ Vagrant::Config.run do |config|
# Configure system flags
sysctl -w kernel.shmmax=1073741824
sysctl -w kernel.yama.ptrace_scope=0
# Run git clone <zsim repo URL> && cd zsim && scons -j16 && you're ready to go
SH
end

0 comments on commit bcd9f19

Please sign in to comment.