This version of Famo.us has been converted to CommonJS format and is ready for use with tools like browserify and commonjs-everywhere. The only changes are:
- Removing the
defineblock from each file
- Unindenting the code in the
requirecalls to use relative paths (in cases where AMD root paths were used)
- Adding this
Famo.us CommonJSsection to the root
README.md. Below this section is the unaltered readme from the official (AMD) Famo.us repo
For an example with browserify, see the tool used to generate this version, Famo.us CommonJS Converter.
Welcome to the Famo.us GitHub repo. If you are interested in evaluating Famo.us, we are now in open beta.
|DOWNLOAD||Famo.us Starter Kit|
|DEMOS||Mobile Interactive Demos (built by the community)|
Simple Installation (Famo.us Starter Kit)
To get up and running quickly, download our 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 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:
Cloning this repository directly is primarily for those wishing to contribute to our codebase. Check out our contributing instructions 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 email@example.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 firstname.lastname@example.org: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.
This package contains the submodules necessary to be productive in Famo.us. They are all hosted on our github organization.
|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
|transitions.git||Transitions are used to create animation, usually by providing input to a Modifier.|
|utilities.git||Utilities hosts various helper classes and static methods.|
|views.git||Views are visually interactable components for use in applications.|
|widgets.git||Widgets are small visually interactable components for use in applications with their own styling.|
- High-level documentation: guides.
- Rendered versions of the source code reference documentation: docs.
- Small examples of each Famo.us component: examples repository.
- If you would like to report a bug, please check the issues section in our contributing instructions.
- Join us in our IRC channel #famous at irc.freenode.net. Freenode maintains this getting started guide for those new to IRC.
- For contributors, read more instructions in CONTRIBUTING.md.
- Famo.us' client-side development package is licensed under the Mozilla public license version 2.0. More information can be found at Mozilla.
- Mozilla also maintains an MPL-2.0 FAQ that should answer most questions you may have about the license.
- Contact email@example.com for further inquiries.
Copyright (c) 2014 Famous Industries, Inc.