Skip to content

Commit

Permalink
README: added a little more detail about what Crafty Vagrant contains…
Browse files Browse the repository at this point in the history
…; added a note about `grunt watch`
  • Loading branch information
Nick Fraenkel committed Dec 9, 2014
1 parent 23ec6d0 commit 4078976
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
@@ -1,6 +1,6 @@
# Crafty Vagrant

A neat starting point / development environment for [Craft](http://buildwithcraft.com/)-based projects, with Vagrant configured and (very nearly) ready to go.
A neat starting point / development environment for [Craft](http://buildwithcraft.com/)-based projects, with [Vagrant](https://www.vagrantup.com/) configured and (very nearly) ready to go, [Grunt](http://gruntjs.com/) set up to take care of things like rendering Sass, minifying Javascript, CSS, and images, [Neat](http://neat.bourbon.io/) for elegant, semantic grid layouts, and a couple of shell scripts to simplify installing / restoring the database from backup.

## Pre-requisites
* [Bower](http://bower.io/)
Expand All @@ -26,6 +26,7 @@ Be sure to follow these steps carefully if you want Crafty Vagrant to behave!

## Notes

* `grunt watch` when you're ready to start developing: this will watch for changes to Sass, Javascript, or images, and perform appropriate tasks (compiling Sass, minifying javascript, etc)
* If this is a fresh install of Craft, you may see error pages until you've installed it by visiting [http://craft.dev/admin/install](http://craft.dev/admin/install)
* Crafty has a database-provisioning shell script. If you run `vagrant provision --provision-with shell`, the most recent backup in `app\craft\storage\backups` will be restored. (Of course, you'll lose any current state of the database, so only do this when you're happy for that to happen)

Expand Down

0 comments on commit 4078976

Please sign in to comment.