Permalink
Browse files

Basic documentation for getting started

  • Loading branch information...
1 parent d89b75b commit ad3465efa9115cd13e87b9abc4b43dfccb4961dd @csswizardry committed Mar 7, 2013
Showing with 16 additions and 1 deletion.
  1. +16 −1 README.md
View
@@ -2,4 +2,19 @@
# inuit.css web template
-Web template for housing the inuit.css framework as submodule
+This is the inuit.css web template; the wrapper for the popular
+[inuit.css](https://github.com/csswizardry/inuit.css) framework.
+
+This template is a barebones and unopinionated directory structure which simply
+allows you to include the inuit.css core library in your builds as an updatable
+Git submodule.
+
+To quickly install inuit.css, run the following commands:
+
+ $ git clone --recursive git@github.com:csswizardry/inuit.css-web-template.git your-project-folder
+ $ cd your-project-folder
+ $ ./go
+
+For a more detailed overview on what inuit.css is, and how to install and use
+it, please refer to the documentation in the README in
+[the main inuit.css repository](https://github.com/csswizardry/inuit.css).

0 comments on commit ad3465e

Please sign in to comment.