Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updating readme to explain my fork.

  • Loading branch information...
commit a01e59a1f4ef86db018341bae0f913357d9244f0 1 parent ee858c6
Jacob Swartwood authored June 10, 2011

Showing 1 changed file with 19 additions and 15 deletions. Show diff stats Hide diff stats

  1. 34  README.mdown
34  README.mdown
Source Rendered
... ...
@@ -1,34 +1,38 @@
1  
-## Description
  1
+## Modifications
2 2
 
3  
-**AckMate** is a [TextMate](http://macromates.com/) plugin for running [Ack](http://betterthangrep.com) in a Cocoa window.
  3
+**This is is a modified version of [AckMate](https://github.com/protocool/AckMate)** Once/if [protocool](https://github.com/protocool) pulls these changes, I recommend switching back to his git repo. That said, some of my changes violate his rule about not changing ack; if they never make the cut, you'll still be able to find a copy here.
4 4
 
5  
-*This plugin is only compatible with Mac OS X 10.5 and above.*
  5
+Changes include:
  6
+- Added standard TextMate folder references via ack -G
  7
+- Updated the XCode build configuration for 10.6 (and modified ragel path to avoid build confusion)
  8
+- Added better UTF-8 error output
6 9
 
7  
-## Donations
  10
+## Description
8 11
 
9  
-Like many of you, I do this sort of thing to keep my family warm, clothed, and fed. Every hour I spend on AckMate is an hour that I'm not billing for.
  12
+**AckMate** is a [TextMate](http://macromates.com/) plugin for running [Ack](http://betterthangrep.com) in a Cocoa window.
10 13
 
11  
-If you find AckMate useful, a small [donation](http://pledgie.com/campaigns/9779) is a great way to show your appreciation.
  14
+*This plugin is only compatible with Mac OS X 10.6 and above.*
12 15
 
13 16
 ## Binary Installation
14 17
 
15  
-* Download the latest release from the [downloads section](http://github.com/protocool/AckMate/downloads)
16  
-* Save any unsaved documents you have open in TextMate
17  
-* Unpack the zip file and double-click the AckMate.tmplugin icon
  18
+- Download the latest release from the [downloads section](http://github.com/jswartwood/AckMate/downloads)
  19
+- Save any unsaved documents you have open in TextMate
  20
+- Unpack the zip file and double-click the AckMate.tmplugin icon
18 21
 
19 22
 ## Usage
20 23
 
21  
-Check the wiki for usage instructions.
  24
+Check the [wiki](https://github.com/protocool/AckMate/wiki) for usage instructions.
22 25
 
23 26
 ## Building From Source
24 27
 
25  
-AckMate's build process requires [Ragel](http://www.complang.org/ragel/) to be in your PATH.
  28
+AckMate's build process requires [Ragel](http://www.complang.org/ragel/) to be in */usr/local/bin* if you have it installed elsewhere please update XCode configuration or symlink to your install location.
26 29
 
27  
-## Contributing
  30
+Installing Ragel is easiest with [Homebrew](http://mxcl.github.com/homebrew/)
28 31
 
29  
-I'm always willing to look at a pull request.
  32
+    brew install ragel
30 33
 
31  
-However, **any** pull requests that include changes to the `ackmate_ack.autogenerated` file will be ignored without comment.
  34
+## Contributing
32 35
 
33  
-Changes to ack itself should be directed to Andy Lester (the author of ack) via his [github repo](http://github.com/petdance/ack). I will periodically rebase AckMate's version of ack against the offical ack release.
  36
+I'm all ears... send pull requests if you have them.
34 37
 
  38
+If you find AckMate useful, donate to [protcool](http://pledgie.com/campaigns/9779) (the original author) or [me](https://flattr.com/donation/give/to/jswartwood) (if you have just been dying for these change :)

0 notes on commit a01e59a

Please sign in to comment.
Something went wrong with that request. Please try again.