Browse files

remove unused files, add gitignore, convert readme to markdown

  • Loading branch information...
1 parent 6977c24 commit 7777b2676f402e432b797a82a89b60efee40bd28 @hakimel hakimel committed Jan 7, 2013
Showing with 20 additions and 39 deletions.
  1. BIN .DS_Store
  2. +2 −0 .gitignore
  3. +0 −11 .project
  4. +18 −28 README.txt → README.md
View
BIN .DS_Store
Binary file not shown.
View
2 .gitignore
@@ -0,0 +1,2 @@
+.project
+.DS_Store
View
11 .project
@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
- <name>Meru_Logo</name>
- <comment></comment>
- <projects>
- </projects>
- <buildSpec>
- </buildSpec>
- <natures>
- </natures>
-</projectDescription>
View
46 README.txt → README.md
@@ -1,29 +1,20 @@
-0.1 Initial release
-
-
-Example
--------
-http://yugen.ca/lab/yugenlogo/source/index.html
-
+## Example
+<http://yugen.ca/lab/yugenlogo/source/index.html>
-Authors
--------
-Hakim El Hattab - Development - http://hakim.se
-Garus Booth - Founder / Art Direction / Design - http://bythebooth.com
-Ram Puvanesasingham - Founder - http://yugen.ca
-Kuhan Puvanesasingham - Founder - http://yugen.ca
+## Authors
+- Hakim El Hattab - Development - <http://hakim.se>
+- Garus Booth - Founder / Art Direction / Design - <http://bythebooth.com>
+- Ram Puvanesasingham - Founder - <http://yugen.ca>
+- Kuhan Puvanesasingham - Founder - <http://yugen.ca>
-
-Yugen Logo Documentation
-========================
+## Yugen Logo Documentation
This document outlines the functionality built into the Yugen logo animation project and aims to explain the source architecture on a high level.
-Fallback
---------
+### Fallback
The primary logo animation is rendered on the HTML5 canvas element but there are also two levels of degraded experiences depending on what level of support is detected. Layer by layer:
@@ -34,26 +25,25 @@ The primary logo animation is rendered on the HTML5 canvas element but there are
3. If Javascript is available AND canvas support is detected, we run the intended canvas animation. Bells. Whistles. The works!
-JavaScript Structure
---------------------
+### JavaScript Structure
The core of the logo animation logic and display is in the source/js/yugenlogo.js file. Any type of interaction input that affects the logo is stored in a separate plug-in JavaScript file. This decoupling enables a flexible architecture that simplifies the process of adding new, or removing old, types of input. Input files are stored in the source/js/input/ folder.
-Configuration
--------------
+### Configuration
The index.html file delivered with this project contains some debug elements which help test the configuration values of the logo.
The logo has an extensive range of options available to configure the properties of shapes, fallback images, framerate, colors and much more. The default options with inline documentation can be found in source/js/yugenlogo.js, note that not all of these are exposed in the debug panel. Options can be overridden when calling the YugenLogo.initialize method, see the bottom of index.html for an example of this.
-Build script
-------------
+### Build script
There are Ant build scripts available in the build/ folder to help simplify the deployment process. This script takes everything in the source/ folder, minifies it, and moves it to the deploy folder.
+## Changelog
+0.1 Initial release
+
-License
--------
+## License
MIT licensed
-Copyright (C) 2013
-Yugen Inc. http://yugen.ca
+Copyright (C) 2013
+Yugen Inc. http://yugen.ca

0 comments on commit 7777b26

Please sign in to comment.