-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
angelsanchez
committed
Nov 17, 2012
1 parent
3843b5b
commit 8503a8c
Showing
233 changed files
with
15,795 additions
and
25,021 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Contributing | ||
|
||
## Important notes | ||
Please don't edit files in the `dist` subdirectory as they are generated via grunt. You'll find source code in the `src` subdirectory! | ||
|
||
### Code style | ||
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.** | ||
|
||
### PhantomJS | ||
While grunt can run the included unit tests via [PhantomJS](http://phantomjs.org/), this shouldn't be considered a substitute for the real thing. Please be sure to test the `test/*.html` unit test file(s) in _actual_ browsers. | ||
|
||
See the [Why does grunt complain that PhantomJS isn't installed?](https://github.com/gruntjs/grunt/blob/master/docs/faq.md#why-does-grunt-complain-that-phantomjs-isnt-installed) guide in the [Grunt FAQ](https://github.com/gruntjs/grunt/blob/master/docs/faq.md) for help with installing or troubleshooting PhantomJS. | ||
|
||
## Modifying the code | ||
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed. | ||
|
||
Test that grunt is installed globally by running `grunt --version` at the command-line. If grunt isn't installed globally, run `npm install -g grunt` to install the latest version. _You may need to run `sudo npm install -g grunt`._ | ||
|
||
_Note that in Windows, you may have to run `grunt.cmd` instead of `grunt`._ | ||
|
||
1. Fork and clone the repo. | ||
1. Run `npm install` to install all dependencies (including grunt). | ||
1. Run `grunt` to grunt this project. | ||
|
||
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken. | ||
|
||
## Submitting pull requests | ||
|
||
1. Create a new branch, please don't work in your `master` branch directly. | ||
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail. | ||
1. Fix stuff. | ||
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done. | ||
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere. | ||
1. Update the documentation to reflect any changes. | ||
1. Push to your fork and submit a pull request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
New BSD License | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions | ||
are met: | ||
1. Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
2. Redistributions in binary form must reproduce the above copyright | ||
notice, this list of conditions and the following disclaimer in the | ||
documentation and/or other materials provided with the distribution. | ||
3. Neither the name of copyright holders nor the names of its | ||
contributors may be used to endorse or promote products derived | ||
from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED | ||
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS OR CONTRIBUTORS | ||
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,30 @@ | ||
# Iris | ||
|
||
Iris is not only another framework. | ||
|
||
Iris provides different client-side optimization techniques for front construction. It is independent and compatible with any server-side technology: JAVA, PHP, Python, GOOGLE APP ENGINE, .NET... | ||
Iris is not only another framework. It is a methodology that will help you to build structured and organized Web applications: | ||
|
||
* Strong object oriented coding and file system organization | ||
* Presenter-View-Resource pattern | ||
* Easy and fast templating engine | ||
* Load resources on demand and self-controlled dependencies | ||
* One page navigation using Hash-URL | ||
* 100% Client multilanguage support | ||
* Crossbrowser: Chrome, Firefox e Internet Explorer | ||
* Light and fast: 14 KB | ||
* Open source: New BSD License | ||
|
||
|
||
## API | ||
http://intelygenz.github.com/iris/api/v0.4.5/ | ||
This JavaScript library provides different client-side optimization techniques for front construction. | ||
|
||
## Getting Started | ||
https://github.com/intelygenz/iris/wiki/Getting-Started | ||
|
||
## Cookbook | ||
https://github.com/intelygenz/iris/wiki/Cookbook | ||
Download the [production version][min] or the [development version][max]. | ||
|
||
## Iris Life Cycle | ||
https://github.com/intelygenz/iris/wiki/Iris-Life-Cycle | ||
[min]: https://raw.github.com/iris-js/iris/master/dist/iris.min.js | ||
[max]: https://raw.github.com/iris-js/iris/master/dist/iris.js | ||
|
||
## Examples | ||
https://github.com/intelygenz/iris/wiki/Examples | ||
|
||
## Installation | ||
|
||
Download the lastest version from http://intelygenz.github.com/iris/ | ||
In your web page: | ||
|
||
```html | ||
<script type='text/javascript' src="iris-0.4.5.min.js"></script> | ||
<script src="jquery.js"></script> | ||
<script src="dist/iris.min.js"></script> | ||
<script> | ||
jQuery(function($) { | ||
$.awesome(); // "awesome" | ||
}); | ||
</script> | ||
``` | ||
|
||
Iris requires *JQuery 1.5+*: | ||
http://jquery.com/ | ||
## Documentation | ||
_(Coming soon)_ | ||
|
||
## Examples | ||
_(Coming soon)_ | ||
|
||
## Release History | ||
_(Nothing yet)_ |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.