From bcd9f19240899fed2f933d350a79ab3b20171a06 Mon Sep 17 00:00:00 2001 From: Mark Jeffrey Date: Wed, 13 Apr 2016 15:22:51 -0400 Subject: [PATCH] [README] Offer simpler Vagrant instructions, using the traditional process --- README.md | 29 ++++++++++++++++++----------- misc/Vagrantfile | 2 -- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 75f0e812..f6298ab2 100644 --- a/README.md +++ b/README.md @@ -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 ----- diff --git a/misc/Vagrantfile b/misc/Vagrantfile index 00290dbf..86ccae55 100644 --- a/misc/Vagrantfile +++ b/misc/Vagrantfile @@ -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 && cd zsim && scons -j16 && you're ready to go SH end