Skip to content

Latest commit

 

History

History
105 lines (69 loc) · 4.18 KB

README.md

File metadata and controls

105 lines (69 loc) · 4.18 KB
Raw

[jQuery ajaxHooks] - a collection of jQuery.ajax extensions

What you need to build your own ajaxHooks

In order to build ajaxHooks, you need to have GNU make 3.8 or later, Node.js 0.2 or later, and git 1.7 or later. (Earlier versions might work OK, but are not tested.)

Windows users have two options:

  1. Install msysgit (Full installer for official Git), GNU make for Windows, and a binary version of Node.js. Make sure all three packages are installed to the same location (by default, this is C:\Program Files\Git).
  2. Install Cygwin (make sure you install the git, make, and which packages), then either follow the Node.js build instructions or install the binary version of Node.js.

Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from Apple's Xcode site) and http://mxcl.github.com/homebrew/. Once Homebrew is installed, run brew install git to install git, and brew install node to install Node.js.

Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source if you swing that way. Easy-peasy.

How to build ajaxHooks

First, clone a copy of the main ajaxHooks git repo by running git clone https://github.com/jaubourg/ajaxHooks.git.

Then, to get a complete, minified, jslinted version of ajaxHooks, simply cd to the ajaxHooks directory and type make. If you don't have Node installed and/or want to make a basic, uncompressed, unlinted version of ajaxHooks, use make ajaxHooks instead of make.

The built version of ajaxHooks will be put in the dist/ subdirectory.

To remove all built files, run make clean.

Building to a different directory

If you want to build ajaxHooks to a directory that is different from the default location, you can specify the PREFIX directory: make PREFIX=/home/ajaxhooks/test/ [command]

With this example, the output files would end up in /home/ajaxhooks/test/dist/.

Troubleshooting

Sometimes, the various git repositories get into an inconsistent state where builds don't complete properly (usually this results in the jquery-ajaxhooks.js or jquery-ajaxhooks.min.js being 0 bytes). If this happens, run make clean, then run make again.

Git for dummies

As the source code is handled by the version control system Git, it's useful to know some features used.

Submodules

The repository uses submodules, which normally are handled directly by the Makefile, but sometimes you want to be able to work with them manually.

Following are the steps to manually get the submodules:

  1. git clone https://github.com/jaubourg/ajaxHooks.git
  2. git submodule init
  3. git submodule update

Or:

  1. git clone https://github.com/jaubourg/ajaxHooks.git
  2. git submodule update --init

Or:

  1. git clone --recursive https://github.com/jaubourg/ajaxHooks.git

rebasing

For feature/topic branches, you should always used the --rebase flag to git pull, or if you are usually handling many temporary "to be in a github pull request" branches, run following to automate this:

  • git config branch.autosetuprebase local (see man git-config for more information)

handling merge conflicts

If you're getting merge conflicts when merging, instead of editing the conflicted files manually, you can use the feature git mergetool. Even though the default tool xxdiff looks awful/old, it's rather useful.

Following are some commands that can be used there:

  • Ctrl + Alt + M - automerge as much as possible
  • b - jump to next merge conflict
  • s - change the order of the conflicted lines
  • u - undo an merge
  • left mouse button - mark a block to be the winner
  • middle mouse button - mark a line to be the winner
  • Ctrl + S - save
  • Ctrl + Q - quit