Getting started

From jQuery SDK

Contents 1 System requirements 1.1 Mac OS X 1.2 Windows 2 Download 2.1 Unpacking 3 Start SDK Tools and create create an project 3.1 Open Terminal / CMD 3.2 Starting with a new project 3.3 Open your project 3.4 Build your project 3.5 Open your built project 3.6 Quit

System requirements

The jQuery SDK Project Tools requires Java and php.

Mac OS X

• In general php is already installed or Download
• Apple supplies their own version of Java. Use the Software Update feature (available on the Apple menu) to check that you have the most up-to-date version of Java for your Mac.

Windows

• php 5: Download
• Java Runtime: Download

Download

Visit the download page to get the latest version of jQuery SDK.

Unpacking

Unpack the downloaded zip archive

Open the jquerysdk folder to see the basic files of jQuery SDK.

Folder and file description:

• Repsitory: includes script, style, test and docu files of jQuery SDK
• Resorces: includes cache and tool resources
• SDK: the comand line tool to administrate projects, caching, ...

Start SDK Tools and create create an project

Open Terminal / CMD

Start a terminal/cmd window and open your jquerysdk folder.

Start the SDK tools.

Starting with a new project

The jQuery SDK command line tools have an easy to use user interface. You have only select a menu key char and press enter.

Open the 'Project' menu.

Select 'c' to create your new project.

Type your project name (only these characters are allowed A-Z, 0-9 and -).

See the success information and press any key.

Open your project

Have a look in the new 'Project' folder for your project directory.

Extended overview:

• qdoc directory for your documentation
• qunit directory for your test cases
• script directory for your javascript
• style directory for your css styles

Some folders like 'jQuery' or 'quint' are only symbolic links to the original folders in the 'Repository'. In the special 'pkg' folders, in 'script' or 'style' directory, you can add files with packege definitions read more.

Default script packege file.

Default style packege file.

Build your project

Select 'b' to open the build menu.

Select your project by number. (This process may take some time)

See the success information and press enter.

Open your built project

Your built project is in the 'Projects' folder also, named with the suffix '.build'. Built projects doesn't have 'qdoc' and 'qunit' files.

Defined Javascript packeges are built and minified.

Defined style (CSS) packeges are built and minified.

Quit

Select 'q' to quit the jQuery SDK tools.