Skip to content
This repository has been archived by the owner on Jun 14, 2020. It is now read-only.

Commit

Permalink
Remove old Makefile system in favou of grunt.js and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Craga89 committed Jul 23, 2012
1 parent dbdf182 commit 6f76e21
Show file tree
Hide file tree
Showing 40 changed files with 10,958 additions and 13,564 deletions.
File renamed without changes.
22 changes: 22 additions & 0 deletions LICENSE-MIT
@@ -0,0 +1,22 @@
Copyright (c) 2012 Craig Michael Thompson

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
19 changes: 0 additions & 19 deletions MIT-LICENSE.txt

This file was deleted.

90 changes: 0 additions & 90 deletions Makefile

This file was deleted.

14 changes: 11 additions & 3 deletions README.md
Expand Up @@ -18,7 +18,6 @@ More documentation and information is available at the [official site](http://cr
<img src="http://media1.juggledesign.com/qtip2/images/browsers/64-safari.png" title="Safari 2+, iOS 4+" /> 2+, iOS 4+
</div>


## Getting qTip<sup>2</sup>

### Stable releases
Expand All @@ -29,11 +28,15 @@ you choose what [plugins](/Craga89/qTip2/tree/master/docs/plugins/) you'd like i
You can grab the latest and greatest qTip<sup>2</sup> nightly from the [dist](/Craga89/qTip2/tree/master/dist/) directory and get started quickly. If you want more options
over what plugins are included in your build, take a look below.

Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/Craga89/qtip2/master/dist/jquery.qtip.min.js
[max]: https://raw.github.com/Craga89/qtip2/master/dist/jquery.qtip.js

### Custom builds
You can also build your own qTip<sup>2</sup> script that includes select [plugins](/Craga89/qTip2/tree/master/docs/plugins/) and [styles](/Craga89/qTip2/tree/master/docs/style.md) to reduce the overall file size and remove features
you don't plan on using. Find more information about this [here](/Craga89/qTip2/tree/master/docs/build.md)


## Installation
Now you have the jQuery library and qTip<sup>2</sup> files, it's time to include them within your HTML. I **highly recommend** that all JavaScript includes be placed just before the end *&lt;/body&gt;*
tag as this ensures the DOM is loaded before manipulation of it occurs. This is not a requirement, simply an insiders tip!
Expand All @@ -58,10 +61,15 @@ tag as this ensures the DOM is loaded before manipulation of it occurs. This is
**Note:** Make sure to include either the non-minified *or* the un-minified script, **not both!** <br/>
**Note:** Notice *the jQuery library is included ***before** qTip<sup>2</sup>*. This is absolutely essential for correct functioning of the plugin!

## Release History
_(Nothing yet)_

## Questions or problems?
If you have any questions, please feel free to post on the [support forums](http://craigsworks.com/projects/forums), but before you do make sure to
check out the [thorough documentation](/Craga89/qTip2/tree/master/docs/) both here in the repo and on the [official site](http://craigsworks.com/projects/qtip2).

## License
Copyright (c) 2012 Craig Michael Thompson. Licensed under the MIT, GPL licenses. *See [here](http://jquery.org/license/) for more details.*

## Special thanks
Big shout-out to the jQuery team for providing the directory structure and base files for the git repo, as well as the base-files for the new NodeJS build system!
Big shout-out to ["Cowboy" Ben Alman](https://github.com/cowboy/) for providing the [grunt](https://github.com/cowboy/grunt) build system used by qTip<sup>2</sup>
Binary file removed build/js.jar
Binary file not shown.
34 changes: 0 additions & 34 deletions build/jslint-check.js

This file was deleted.

0 comments on commit 6f76e21

Please sign in to comment.