summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Henrik Mai <lars.mai@kontinui.de>2014-05-02 12:55:40 +0200
committerLars Henrik Mai <lars.mai@kontinui.de>2014-05-02 13:29:33 +0200
commit051904d530aaf02068334b8046c3e93fe81c0bd8 (patch)
treef18e2b7fc8f206a92a81aac2b9f321c2cccf0a1e /README
parentd60b09a31b811523907bcc9cdd83e609539b2ee4 (diff)
add vagrant file and update README
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 42 insertions, 1 deletions
diff --git a/README b/README
index 9622006..0a4e5bf 100644
--- a/README
+++ b/README
@@ -20,6 +20,33 @@ Versuch einer mobile-first sublab website mit middleman (http://middlemanapp.com
(edit files in the source/ directory, browser should autorefresh)
+== Using Vagrant
+
+Install Vagrant from here: http://www.vagrantup.com/downloads.html
+
+ # start the VM; this may take a while on first boot
+ vagrant up
+
+ # .. then start the middleman development server in the VM
+ # (polling is needed because changes to files don't propagate via virtualbox shared folders)
+
+ vagrant ssh -c "cd /vagrant; bundle exec middleman server --force-polling --latency=4"
+
+ # on the hostmachine, open http://localhost:4567
+
+ # to shutdown the VM:
+ vagrant halt
+
+ # to force quit the VM in case Vagrant hangs:
+ vagrant halt -f
+
+ # to reload the VM after changes to Vagrantfile:
+ vagrant reload
+
+ # anything else:
+ vagrant -h
+ vagrant <command> -h
+
== Building
bundle exec middleman build
@@ -28,6 +55,19 @@ Versuch einer mobile-first sublab website mit middleman (http://middlemanapp.com
ruby -run -e httpd ./build -p 5000
open http://localhost:5000
+== Updating
+
+ # update the code
+ git pull
+
+ # update gem dependencies if needed
+
+ # using vagrant:
+ vagrant ssh -c "cd /vagrant; bundle"
+
+ # otherwise just:
+ bundle
+
== Problems / Features
* No CSS yet
@@ -38,4 +78,5 @@ Versuch einer mobile-first sublab website mit middleman (http://middlemanapp.com
* implement a mobile-first grid using Bootstrap
* write a sensible API server for the status box
-* add middleman blog extension and migrate old posts
+
+