From 2c2e5fb86e3916fa6c5fd8e4d78eef2abbaad2f0 Mon Sep 17 00:00:00 2001 From: Johannes Keyser Date: Sun, 9 Apr 2017 12:22:32 +0200 Subject: [PATCH] vagrant: Clarify some details how to use for development --- HACKING | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/HACKING b/HACKING index 586a8ab42..0f4cef143 100644 --- a/HACKING +++ b/HACKING @@ -3,23 +3,26 @@ ## Setting Up Development Environment Using Vagrant Vagrant is a free software command line utility for managing the life -cycle of virtual machines. FreedomBox project provides ready made -virtual machines for use with Vagrant. These images make setting up -of environment for Plinth development rather simple. +cycle of virtual machines. The FreedomBox project provides ready-made +virtual machines (VMs) for use with Vagrant. These images make setting up +an environment for Plinth development rather simple: You can edit the Plinth +source code on your host and immediately see the effects in the running VM. +The entire setup is automatic and requires about 4.5 GB of disk space. 1. Install Vagrant and VirtualBox: - $ sudo apt install virtualbox vagrant + $ sudo apt-get install virtualbox vagrant -2. Download, setup, run and configure virtual machine for Plinth - development using Vagrant: +2. To download, setup, run, and configure a VM for Plinth development + using Vagrant, simply execute in your Plinth development folder: $ vagrant up -3. To access Plinth, visit https://localhost:4430/plinth/ +3. To access Plinth (from host), visit https://localhost:4430/plinth/ -4. Make changes to the source code on your host machine as usual. - Then to make the changes reflect on the virtual machine, run: +4. Edit the source code in your host machine's Plinth development folder. + By default, this folder is shared within the VM, at /vagrant/. + To actually reflect the changes in the running VM, run on your host: $ vagrant provision