Reboot README.

1 files changed, 45 insertions, 0 deletions

diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..b8c4362
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,45 @@
+## Description
+
+mach_override enables you to override functions (even system-supplied ones like `malloc`) at runtime on Mac OS X. 
+
+"Overriding" means you can extend existing functions by head-patching or tail-patching them or you can wholly replace their implementation by not calling the function's original code. All this at a fairly high-level (if you can call C high-level).
+
+## Version History
+
+### mach_override 1.2: Thu Aug 9 2012
+
+* [NEW] i386 and x86_64 support.
+
+* [CHANGE] Decoupled from mach_star. Most of folks were just using the mach_override side of mach_star and this simplifies things (docs, tests).
+
+* [CHANGE] Threw away Xcode projects. Trying to get them to work across new and old system versions and Xcode versions is a fool's game. Now there's a Rakefile. Type `rake`. You've built and tested. Ta-da.
+
+### mach_star 1.1.1: Sun Dec 18 2005
+
+* General Xcode 2.2 project cleanup. mach_star now includes `.xcodeproj` Xcode 2.2 project files for all of its projects. The old `.xcode` project files have been left in place, but they aren't maintained and may not work. Xcode 2.2 is the recommended mach_star development environment -- Xcode 2.1 had a bug with inter-project dependancies which would cause compilation failure. It works now again in Xcode 2.2.
+
+* Inter-project dependancies should working under Xcode 2.2. Any project you pick, you should just be able to hit the "Build" button and everything should Just Work™.
+
+* There was a stray reference to my username in one of the project, which causes compilation headaches for some folks.
+
+* Bug fix: in `mach_inject_bundle.c`'s `mach_inject_bundle_pid()` I no longer call `CFRelease()` on the framework bundle reference. Reported by Scott Kevill.
+
+* Added some explicit casts now required by gcc 4.
+
+* Added this document.
+
+### mach_star 1.1: Wed Apr 06 2005
+
+* New package added: `mach_inject_bundle`. It has a private subproject: `mach_inject_bundle_stub`. The stub is a generic reusable implementation of the code that gets squirted across the address spaces, which was always tricky to write. `mach_inject_bundle` is an embeddable framework that wraps `mach_inject` and the stub with a simple fire-and-forget API.
+
+* The "DisposeWindowBeeperOverride" example is replaced by "DisposeWindow+Beep".
+
+* The "FinderDisposeWindowBeeperInjector" is replaced by "DisposeWindow+Beep_Injector".
+
+* All the text is now wrapped to 80 chars wide. Done to print nicely in Scott Knaster's [Hacking Mac OS X Tiger](http://www.amazon.com/exec/obidos/ASIN/076458345X). Probably will undo this word-wrap in the future. We all have widescreens nowadays, right? ;-)
+
+* Thanks to Jon Gotow for letting me peek at `SCPatch`, which I used as a guide for `mach_inject_bundle`. It saved me a bunch of time. Also thanks to Bob Ippolito for `CALL_ON_LOAD` assistance.
+
+### mach_star 1.0: Wed Jun 18 2003
+
+* Initial release at MacHack 2003.
\ No newline at end of file