Famo.us CommonJS
================
This version of Famo.us has been converted to CommonJS format and is ready for use with tools like [browserify](http://browserify.org/) and [commonjs-everywhere](https://github.com/michaelficarra/commonjs-everywhere). The only changes are:
1. Removing the `define` block from each file
2. Unindenting the code in the `define` block
3. Modifying `require` calls to use relative paths (in cases where AMD root paths were used)
4. Adding this `Famo.us CommonJS` section to the root `README.md`.
Below this section is the unaltered readme from the [official (AMD) Famo.us repo](https://github.com/Famous/famous)
For an example with browserify, see the tool used to generate this version, [Famo.us CommonJS Converter](https://github.com/aelr/famous-commonjs-converter).
Famo.us
=======
Welcome to the Famo.us GitHub repo. If you are interested in evaluating Famo.us, we are now in open beta.
| RESOURCE | LINK |
|------------|---------|
| **DOWNLOAD** | [Famo.us Starter Kit][starter-kit] |
| **LEARN** | [Famo.us University][famous-university] |
| **DOCS** | [Documentation][famous-docs] |
| **HELP** | [IRC Channel][IRC] |
| **DEMOS** | [Mobile Interactive Demos][famous-demos] (*built by the community*)|
| **ANGULAR INTEGRATION** | [ng.us][famous-angular] |
## About
Famo.us is a free and open source JavaScript platform for building mobile apps and desktop experiences. What makes Famo.us unique is its JavaScript rendering engine and 3D physics engine that gives developers the power and tools to build native quality apps and animations using pure JavaScript. Famo.us runs on iOS, Android, Kindle and Firefox devices and integrates with [Angular][famous-angular], Backbone, Meteor and Facebook React. [Famo.us University][famous-university] is a free live coding classroom that teaches all levels of developers how to utilize Famo.us to build beautiful experiences on every screen.
## Installation
### Simple Installation (*Famo.us Starter Kit*)
To get up and running quickly, download our [**starter kit**][starter-kit]. We've loaded it with examples, demos, reference documentation, and higher-level guides.
### Advanced Installation (*Grunt Toolbelt*)
If you would like to scaffold an app with Famo.us from the command line, install our [yeoman generator][github-generator] via npm.
npm install -g yo grunt-cli bower generator-famous
mkdir newProject
cd newProject
yo famous
grunt serve
Preparing your project for distribution is then as simple as:
grunt
## Contributing
Cloning this repository directly is primarily for those wishing to contribute to our codebase. Check out our [contributing instructions][contributing] to get involved. Since we use git submodules, all subfolders will be unpopulated unless you initialize and update your submodules. To clone from the command line, run
git clone git@github.com:Famous/famous.git path/to/folder
cd path/to/folder
git submodule update --init
Or clone with the `--recursive` flag for a conveninent the one-liner
git clone git@github.com:Famous/famous.git --recursive path/to/folder
Note: cloning only provides the Famo.us folder with all Famo.us code, but it does no application scaffolding. You will additionally need to create your own index.html, and include the `famous.css` file that is included in `famous/core`. Require.js is currently a hard dependency for using Famo.us.
## Famous.git Package
This package contains the submodules necessary to be productive in Famo.us. They are all hosted on [our github organization][famous-organization-github].
| Submodule | Description |
| --------- | ----------- |
| core.git | The low level componentry of Famo.us, plus the required famous.css stylesheet. |
| events.git | Events are used for communication between objects in Famous. |
| inputs.git | The inputs library is used to interpret user input to the device. |
| math.git | A simple math library used throughout the core. |
| modifiers.git | Implementations of the core/Modifier pattern which output transforms to the render tree. |
| physics.git | Core engine controlling animations via physical simulation. |
| surfaces.git | Surfaces extend core/Surface and encapsulate common HTML tags like `![]()
` and `