added base files.

mandric · Mar 7, 2012 · eded400 · eded400
commit eded400
Show file tree

Hide file tree

Showing 3 changed files with 174 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,29 @@
+PACKAGE = kanso-bootstrap
+BUILDDIR = dist
+CHECKOUTDIR = bootstrap
+
+all: init build
+
+build:	
+	mkdir -p $(BUILDDIR)/bootstrap/{less,js,docs,font}
+	cp kanso.json README.md $(BUILDDIR)
+	cp -rp $(CHECKOUTDIR)/less/* $(BUILDDIR)/bootstrap/less
+	cp -rp $(CHECKOUTDIR)/js/*.js $(BUILDDIR)/bootstrap/js
+	cp -rp $(CHECKOUTDIR)/docs/* $(BUILDDIR)/bootstrap/docs
+	cp -rp $(CHECKOUTDIR)/font/* $(BUILDDIR)/bootstrap/font
+	cp $(CHECKOUTDIR)/LICENSE \
+	   $(CHECKOUTDIR)/README.md \
+	   $(BUILDDIR)/bootstrap/
+
+init: 
+	git submodule init
+	git submodule update
+
+deploy:
+	kanso publish dist
+
+redeploy:
+	kanso publish -f dist
+
+clean: 
+	rm -rf $(BUILDDIR)
diff --git a/README.md b/README.md
@@ -0,0 +1,121 @@
+# Kanso Bootstrap
+
+This package allows you to quickly start using [Twitter
+Bootstrap](http://twitter.github.com/bootstrap/) and Less in your Kanso
+project. 
+
+## Install
+
+Add to your project's kanso.json dependencies setting, here is the minimal
+case:
+
+```json
+"dependencies": {
+    "attachments": null,
+    "less-precompiler": null,
+    "bootstrap": null
+}
+```
+
+Run kanso install to install in your packages directory:
+
+```
+kanso install
+```
+
+## Configure 
+
+Configure bootstrap to be compiled with Less.
+
+### Compiled CSS
+
+Create a css/less file `static/css/example.less` for your site that
+includes bootstrap:
+
+```css
+@import "bootstrap/less/bootstrap.less";
+/* Now use bootstrap and less! */
+body { background-color: @pink; }
+```
+
+Include the less file in your HTML:
+
+*Note* we refer to the file with a `.css` extention because that is what it
+compiles to.
+
+```html
+<html>
+  <head>
+    <link rel="stylesheet" type="text/css" href="static/css/example.css" />
+  </head>
+  <body>
+    <h1>Hello, world!</h1>
+  </body>
+</html>
+```
+
+Include a `less` section in your `kanso.json` to compile less files and attach
+them as css:
+
+```json
+{
+    "name": "example-app",
+    "version": "0.0.1",
+    "description": "The simplest possible app with bootstrap and less support.",
+    "attachments": ["index.html", "static"],
+    "less": {
+        "compress": true,
+        "compile": ["static/css/example.less"],
+        "remove_from_attachments": true
+    },
+    "dependencies": {
+        "attachments": null,
+        "less-precompiler": null,
+        "bootstrap": null
+    }
+}
+```
+
+### Icons
+
+Bootstrap 2.0 provides icons with the following html:
+
+```html
+<i class="icon-chevron-left"></i>
+```
+
+The images and js files are include as attachments when you build your design
+doc, but the default path needs adjustment.  To reference your sprite `png`
+files modify the less variables. e.g.
+
+```
+@iconSpritePath: "../../bootstrap/img/glyphicons-halflings.png";
+@iconWhiteSpritePath: "../../bootstrap/img/glyphicons-halflings-white.png";
+```
+
+## Deploy
+
+Do a kanso push to make the build and deploy to your CouchDB:
+
+```
+kanso push example
+```
+
+## Docs
+
+You an browse the Bootstrap docs locally in the package directory under
+`bootstrap/docs/index.html` or check the website.
+
+## Upgrading
+
+### 2.0.1-kanso.2
+
+Attaching images and js files by default now.  You may have to adjust your less
+code to your sprite path as shown in the Icons section.
+
+### 2.0.1-kanso.1
+
+The directory structure changed so instead of including lib/bootstrap.less you
+include less/bootstrap.less. You also need to update the sprite image path, see
+the Icons section above.
+
diff --git a/kanso.json b/kanso.json
@@ -0,0 +1,24 @@
+{
+    "name": "bootstrap-fontawesome",
+    "version": "2.0.1-kanso.1",
+    "categories": ["frontend"],
+    "maintainers": [
+        {
+            "name": "Milan Andric",
+            "url": "http://m.andric.us"
+        }
+    ],
+    "url": "http://github.com/mandric/kanso-bootstrap-fontawesome",
+    "attachments": [
+        "bootstrap/font",
+        "bootstrap/js"
+    ],
+    "less": {
+        "paths": ["."]
+    },
+    "dependencies": {
+        "attachments": null,
+        "less-precompiler": null
+    },
+    "description": "Less files for bootstrap with font-awesome icons and javascript plugins, allowing you to modify the base variables and choose which parts to use before compiling to css on push."
+}