diff options
author | rentzsch <jwr.git@redshed.net> | 2012-08-10 09:02:27 +0400 |
---|---|---|
committer | rentzsch <jwr.git@redshed.net> | 2012-08-10 09:02:27 +0400 |
commit | d6abe225a80e379aa6f2396be28fa6c93405ccd5 (patch) | |
tree | 78dbb7bf728e064779fd78e80a1bc6cefb4d0ec6 | |
parent | b317f7ee12e7c5791554bd511368226588a96de7 (diff) |
better readme
-rw-r--r-- | README.markdown | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown index 70220ef..2115af1 100644 --- a/README.markdown +++ b/README.markdown @@ -1,8 +1,10 @@ ## Description -mach_override enables you to override functions (even system-supplied ones like `malloc`) at runtime on Mac OS X. +mach_override enables you to override ("patch") program- and system-supplied functions at runtime. You can fully replace functions with your implementations, or merely head- or tail-patch the original implementations to add functionality and/or work around bugs. -"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). +## Contributing + +Please base your work off the unstable branch. After making your changes please re-run `rake` to ensure it compiles cleanly and the tests pass. Then submit your Pull Request. ## Version History |