From 41e800cfe3850c0d24dc203f61d8a1232e842dac Mon Sep 17 00:00:00 2001 From: David Miller Date: Thu, 11 Sep 2014 03:15:45 -0400 Subject: [PATCH] readme update --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f4b36ca..fadbacb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ -Agency by Start Bootstrap -===================== +# Agency by Start Bootstrap Agency is a one page HTML theme for agencies created by Start Bootstrap. This repository is a pre-release that we are using to test integrating themes with Grunt, Bower, and ultimately, creating Yeoman and Brunch scaffolds for all of our open source templates and themes. -To access the current version of this template, visit http://startbootstrap.com/template-overviews/agency/. \ No newline at end of file +To access the current version of this template, visit http://startbootstrap.com/template-overviews/agency/. + +## Using these Source Files + +You can use the source files within this repo to customize the Agency theme. You can custmoize the HTML, CSS (using LESS), and the JavaScript while Grunt watches the files and compiles them automatically for you. To get started, follow the steps below. + +- Clone the repo +- Run `npm install` in the root directory +- After all of the node modules are installed you can either edit files and then run `grunt` to build the new dist folder, or you can run `grunt watch` which will tell Grunt to watch specified files for changes, and update the files in the dist folder automatically. \ No newline at end of file