Permalink
Browse files

Remove old Makefile system in favou of grunt.js and update documentation

  • Loading branch information...
1 parent dbdf182 commit 6f76e214480dc1c134daf5d75d3214d432317bf2 @Craga89 Craga89 committed Jul 23, 2012
File renamed without changes.
View
@@ -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.
View
@@ -1,19 +0,0 @@
-Copyright (c) 2009-2010 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.
View
@@ -1,90 +0,0 @@
-SRC_DIR = src
-BUILD_DIR = build
-
-PREFIX = .
-DIST_DIR = ${PREFIX}/dist
-
-PLUGINS = $(shell ls -p ${SRC_DIR} | grep / | xargs)
-PLUGINS_JS = $(if ${PLUGINS},$(shell find ${PLUGINS:%=${SRC_DIR}/%/} -name "*.js" 2> /dev/null),"")
-PLUGINS_CSS = $(if ${PLUGINS},$(shell find ${PLUGINS:%=${SRC_DIR}/%/} -name "*.css" 2> /dev/null),"")
-
-EXTRA_CSS = ${SRC_DIR}/styles.css\
- ${SRC_DIR}/extra.css
-
-JS_MODULES = ${SRC_DIR}/header.txt\
- ${SRC_DIR}/intro.js\
- ${SRC_DIR}/core.js\
- ${PLUGINS_JS}\
- ${SRC_DIR}/outro.js
-
-CSS_MODULES = ${SRC_DIR}/header.txt\
- ${SRC_DIR}/core.css\
- ${PLUGINS_CSS}\
- ${EXTRA_CSS}
-
-QTIP = ${DIST_DIR}/jquery.qtip.js
-QTIP_MIN = ${DIST_DIR}/jquery.qtip.min.js
-QTIP_CSS = ${DIST_DIR}/jquery.qtip.css
-QTIP_CSS_MIN = ${DIST_DIR}/jquery.qtip.min.css
-
-QTIP_VER = `cat version.txt`
-VER = sed s/@VERSION/${QTIP_VER}/
-
-JS_ENGINE = `which node`
-JS_LINT = ${JS_ENGINE} $(BUILD_DIR)/jslint-check.js
-JS_MINIFIER = ${JS_ENGINE} ${BUILD_DIR}/uglify.js
-CSS_MINIFIER = java -Xmx96m -jar ${BUILD_DIR}/yuicompressor.jar
-
-DATE=`git log --pretty=format:'%ad' -1`
-
-all: clean qtip lint css min
- @@printf "\n%s" ${PLUGIN_JS}
- @@printf "qTip2 built successfully!\n\n"
-
-${DIST_DIR}:
- @@mkdir -p ${DIST_DIR}
-
-qtip: ${DIST_DIR} ${JS_MODULES}
- @@mkdir -p ${DIST_DIR}
-
- @@printf "Building qTip2... Success!\n"
- @@printf "\tEnabled plugins: %s\n\n" $(if ${PLUGINS},"${PLUGINS:%/=%}", "None")
-
- @@cat ${JS_MODULES} | \
- sed 's/Date:./&'"${DATE}"'/' | \
- ${VER} > ${QTIP};
-
-css: ${DIST_DIR} ${CSS_MODULES}
- @@printf "Building CSS... "
- @@cat ${CSS_MODULES} | \
- sed 's/Date:./&'"${DATE}"'/' | \
- ${VER} > ${QTIP_CSS};
- @@printf "Success!\n"
-
-min: qtip css
- @@if test ! -z ${JS_ENGINE}; then \
- printf "Minifying JS... "; \
- head -18 ${QTIP} > ${QTIP_MIN}; \
- ${JS_MINIFIER} ${QTIP} > ${QTIP_MIN}.tmp; \
- sed '$ s#^\( \*/\)\(.\+\)#\1\n\2;#' ${QTIP_MIN}.tmp > ${QTIP_MIN}; \
- rm -rf $(QTIP_MIN).tmp; \
- printf "Success!\n"; \
- else \
- printf "You must have NodeJS installed in order to minify qTip JS.\n"; \
- fi
-
- @@printf "Minifying CSS... "
- @@${CSS_MINIFIER} ${QTIP_CSS} --type css -o ${QTIP_CSS_MIN}
- @@printf "Success!\n"
-
-lint: qtip
- @@if test ! -z ${JS_ENGINE}; then \
- printf "Checking against JSLint... "; \
- ${JS_LINT}; \
- else \
- printf "You must have NodeJS installed in order to test qTip against JSLint."; \
- fi
-
-clean:
- @@printf "Removing distribution directory: %s\n\n" ${DIST_DIR}
- @@rm -rf ${DIST_DIR}
View
@@ -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
@@ -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!
@@ -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>
View
Binary file not shown.
View
@@ -1,34 +0,0 @@
-var JSLINT = require("./lib/jslint").JSLINT,
- src = require("fs").readFileSync("dist/jquery.qtip.js", "utf8");
-
-JSLINT(src, { evil: true, forin: true, maxerr: 100 });
-
-// All of the following are known issues that we think are 'ok'
-// (in contradiction with JSLint) more information here:
-// http://docs.jquery.com/JQuery_Core_Style_Guidelines
-var ok = {
- "Expected an identifier and instead saw 'undefined' (a reserved word).": true,
- "Expected a conditional expression and instead saw an assignment.": true,
- "Expected an identifier and instead saw 'default' (a reserved word).": true,
- "Insecure '.'.": true,
- "Insecure '^'.": true,
- 'Missing "use strict" statement.': true
-};
-
-var e = JSLINT.errors, found = 0, w;
-
-for ( var i = 0; i < e.length; i++ ) {
- w = e[i];
-
- if (w && w.reason && w.evidence && !ok[ w.reason ] ) {
- console.log( "\n" + w.evidence + "\n" );
- console.log( " Problem at line " + w.line + " character " + w.character + ": " + w.reason );
- }
-}
-
-if ( found > 0 ) {
- console.log( "\n" + found + " Error(s) found.\n" );
-
-} else {
- console.log( "Success!\n" );
-}
Oops, something went wrong.

0 comments on commit 6f76e21

Please sign in to comment.