-
Notifications
You must be signed in to change notification settings - Fork 842
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding vagrant doc and fixing indentation in vagrantfile
- Loading branch information
1 parent
d58d6f4
commit 3fe4db5
Showing
2 changed files
with
47 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Using the MMLSpark Vagrant Image | ||
|
||
## Install Vagrant and Dependencies | ||
|
||
You will need to a few dependencies before we get started. These instructions are for using Vagrant on Windows OS. | ||
|
||
1. Ensure [Hyper-V]((https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/) is enabled or install [Virtualbox](https://www.virtualbox.org/) | ||
2. Install a X Server for Windows, [VcXsrv](https://sourceforge.net/projects/vcxsrv/) is a lightweight option. | ||
3. Install the Vagrant version for your OS [here](https://www.vagrantup.com/downloads.html) | ||
|
||
## Build the Vagrant Image | ||
|
||
Start powershell as Administrator and go to the `mmlspark/tools/vagrant` directory and run | ||
|
||
``` | ||
vagrant up | ||
``` | ||
|
||
*Note: you may need to select a network switch, try the Default Switch option if possible* | ||
|
||
## Connect to the Vagrant Image | ||
|
||
First start the X-Window server (XLaunch if using VcXsrv). | ||
|
||
From the same directory (with powershell as Administrator) run | ||
|
||
``` | ||
$env:DISPLAY="localhost:0" | ||
vagrant ssh -- -Y | ||
# now you can start IntelliJ and interact with the GUI | ||
> idea | ||
``` | ||
|
||
|
||
## Stop the Vagrant Image | ||
|
||
``` | ||
vagrant halt | ||
``` | ||
|
||
## Further reading | ||
|
||
This guide covers the bare minimum for running a Vagrant image. For more details see the [Vagrant Documentation](https://www.vagrantup.com/intro/index.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters