splain thyself\!

README.md

@@ -0,0 +1,51 @@
+## What?
+
+*WARNING*: if you don't like caveats, leave now!
+
+*WARNING*: This repo highly experimental!  While the explanation that follows may suggest
+that this repository is actually meaningful, it is not.
+
+*WARNING*: This thing is osx/linux ONLY for now
+
+This repostiory is a remix of the [jetpack-sdk](http://github.com/mozillalabs/jetpack-sdk).  The
+ultimate goal is to build your own browser using (mostly) standard web technologies.
+
+## Getting Started
+
+1. ./run
+
+## What could go wrong?
+
+At present, the `run` script will look for xulrunner on your system
+(or some other mozilla product that provides xulrunner).  If no such
+product exists, everything will come to a grinding halt.  At a future
+date, this repository may grow the ability to acquire and build the
+bits that it needs.
+
+## Hacking
+
+Have a look at the ui/ directory.  This is web-like content that
+comprises the main view of the application.  It will be rendered in an
+unadorned windows.  Feel free to hack on it.
+
+## Deeper Hacking
+
+The content in UI is rendered by a "jetpack module" that lives in
+`packages/app-kit`.  A trimmed down version of jetpack has been
+included inside this repository, and the theory is that we'll remove
+packages that aren't relevant to standalone application development,
+and add some new ones that are.  If you are familiar with jetpack then
+you should be comfortable diving in and hacking on modules.
+
+NOTE: if you want to kick off the jetpack documentation server to
+inspect the modules included here, run `bin/cfx docs` and follow
+instructions.
+
+## cred
+
+this repo is nothing all that novel or interesting, it's all just a remix
+based of the work of atul, myk, marcio, and the jetpack community.
+
+
+
+