Permalink
Browse files

Merge pull request #113 from markcjeffrey/master

[README] Offer simpler Vagrant instructions
  • Loading branch information...
s5z committed Apr 14, 2016
2 parents b36b6dd + bcd9f19 commit fb4d6e0475a25cffd23f0687ede2d43d96b4a99f
Showing with 18 additions and 13 deletions.
  1. +18 −11 README.md
  2. +0 −2 misc/Vagrantfile
View
@@ -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
-----
View
@@ -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 fb4d6e0

Please sign in to comment.