Skip to content
Newer
Older
100644 125 lines (75 sloc) 4.61 KB
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
1 # MooTools More
2 MooTools Plugins and Enhancements Repository
3 [![Build Status](https://travis-ci.org/mootools/mootools-more.svg?branch=master)](https://travis-ci.org/mootools/mootools-more)
86613e3 @anutron adding a todo list to README
anutron authored
4
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
5 ---
1db6790 @anutron adding tests for Assets.js
anutron authored
6
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
7 ## Contribute
1db6790 @anutron adding tests for Assets.js
anutron authored
8
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
9 You are welcome to contribute to MooTools! What we ask of you:
10
11 a. __To report a bug:__
12
b95724b @SergioCrisostomo Typo fix
SergioCrisostomo authored
13 1. Create a [jsFiddle](http://jsfiddle.net/) with the minimal amount of code to reproduce the bug.
ac37012 @SergioCrisostomo remove unnecessary information
SergioCrisostomo authored
14 2. Create a [Github Issue](https://github.com/mootools/mootools-more/issues), and link to the jsFiddle.
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
15
16 b. __To fix a bug:__
17
18 1. Clone the repo.
19 2. Fix the bug.
20 3. Add a [spec](http://jasmine.github.io/1.3/introduction.html).
21 4. Build and run the specs.
22 5. Push to your Github fork.
23 6. Create Pull Request, and send Pull Request.
24
25
b95724b @SergioCrisostomo Typo fix
SergioCrisostomo authored
26 __Do try to contribute!__ This is a community project.
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
27
28 #### TO DO
86613e3 @anutron adding a todo list to README
anutron authored
29
35eccc9 @SergioCrisostomo Polish
SergioCrisostomo authored
30 * change the interactive specs to work without the Clientcide dev app
b95724b @SergioCrisostomo Typo fix
SergioCrisostomo authored
31 * deprecate and remove things from -More that are deprecated or not maintained anymore
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
32 * add touch / mobile functionality
50bbe61 @anutron updating readme with changes from clientcide
anutron authored
33 * make detach method for all classes that attach to elements
34 * make destroy method for all classes that create elements
56ba992 @anutron updating readme
anutron authored
35
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
36 #### StyleGuide
aa24845 @cpojer * Minor cleanups + whitespace fixes + some semicolons
cpojer authored
37
00696e8 @cpojer * Readme styleguide link added
cpojer authored
38 * http://wiki.github.com/mootools/mootools-core/syntax-and-coding-style-conventions
aa24845 @cpojer * Minor cleanups + whitespace fixes + some semicolons
cpojer authored
39
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
40 ## Building & Testing
41
42 Current build process uses [Grunt](http://github.com/gruntjs), [Grunt MooTools Packager plugin](https://github.com/ibolmo/grunt-packager), and [Karma related repos](http://github.com/karma-runner/grunt-karma).
43
44 **By default**, the build process runs the tests (specs) relevant to the build. To build without testing see the `packager` build targets.
45
46 ### Testing locally
47
48 MooTools More has 2 test suites. One interactive that needs you to click & drag elements, and one non-interactive where the Jasmine & Karma do the whole job.
49
50 **To run the interactive** specs you have to install [mootools-ui-runner](https://github.com/arian/mootools-ui-runner). If you follow the link you find the 2 step quick setup.
51
52 **To run the non-interactive** specs you can follow these steps in order:
53
ac37012 @SergioCrisostomo remove unnecessary information
SergioCrisostomo authored
54 $ git clone https://github.com/mootools/mootools-more # clone the MooTools repo
55 $ cd mootools-more # get into the directory
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
56 $ npm install # install de testing tools
57 $ npm install grunt-cli -g # install the Grunt command line interface
58 $ grunt default # run the specs!
59
60
61 You can also change which browser to call in the Gruntfile.js.
62 __Note that__ _most browsers need to be closed when starting tests so Grunt-Karma opens and closes the browser. Otherwise they might not close on its own and fire a timeout error for inactivity._
63
64 Example:
65
66 continuous: {
67 browsers: ['PhantomJS', 'IE', 'Chrome', 'Firefox', 'Safari']
68 },
69
70 If the log is too long, or if you want to store it in a file you can do:
71
b95724b @SergioCrisostomo Typo fix
SergioCrisostomo authored
72 $ grunt > logs.txt # This will create a new file called "logs.txt" in the local directory
8586e44 @SergioCrisostomo Re-factor
SergioCrisostomo authored
73
74
75
76 ### Building MooTools _With_ Compatibility
77 This means `1.5.x` that is compatible with: `1.4.x`, `1.3.x`, `1.2.x`, and so on.
78
79 **Examples**
80
81 grunt # to build and run specs, or
82 grunt packager:all # to only build the source
83
84 ### Building MooTools _Without_ Compatibility
85 This means `1.5.x` **without** deprecated code in `1.4.x`, `1.3.x`, `1.2.x`, and so on.
86
87 ``` js
88 'Proceed at your own risk'
89 See the changelog or the blog related to each version for migrating your code.
90 ```
91
92 **Examples**
93
94 grunt nocompat # to build and run specs, or
95 grunt packager:nocompat # to only build the source
96
97
98 ### Testing on Travis & Sauce Labs
99
100 Every new Build and Pull Request is now tested on [Travis](https://travis-ci.org/) and [Sauce Labs](https://saucelabs.com/). You can also open your own free account on [Travis](https://travis-ci.org/) and [Sauce Labs](https://saucelabs.com/) to test new code ideas there.
101
102 [Travis](https://travis-ci.org/) testing uses [PhantomJS](http://phantomjs.org/) which is a headless browser. When connected to [Sauce Labs](https://saucelabs.com/) then it is possible to choose any number of [different Browsers and Platforms](https://saucelabs.com/platforms). You will need in this case to change the login key so it will match your account.
103
104
105 #### Browsers, Platforms, and More
106
107 This test suite is ready for Travis & SauceLabs.
108 You can also run locally.
109
110 Support:
111
112 - IE
113 - Firefox
114 - Safari
115 - Chrome
116 - Opera
117 - PhantomJS (virtual browser)
118
119
120
121 ## More Information
89c5eca @anutron updating readme for 1.2.4.1
anutron authored
122
1b40677 @SergioCrisostomo Added changelog file for More
SergioCrisostomo authored
123 - [See the MooTools Wiki for more information](http://github.com/mootools/mootools-core/wikis)
b95724b @SergioCrisostomo Typo fix
SergioCrisostomo authored
124 - [See the MooTools More changelog](https://github.com/mootools/mootools-more/blob/master/changelog.md)
125
Something went wrong with that request. Please try again.