commit aefbbb77a3545f61db7b84fb357a51840bc6af73 parent 54883eeb89e16eb20508d83ed792d9c034b588c7 Author: sin <sin@2f30.org> Date: Mon, 5 Aug 2013 12:26:00 +0100 Add README Diffstat:
| M | Makefile | | | 2 | +- |
| A | README | | | 18 | ++++++++++++++++++ |
2 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile @@ -31,7 +31,7 @@ clean: dist: clean @echo creating dist tarball @mkdir -p lemoncake-${VERSION} - @cp -R LICENSE Makefile config.mk \ + @cp -R LICENSE Makefile config.mk README \ spinlock.h tree.h ${SRC} lemoncake-${VERSION} @tar -cf lemoncake-${VERSION}.tar lemoncake-${VERSION} @gzip lemoncake-${VERSION}.tar diff --git a/README b/README @@ -0,0 +1,18 @@ +How to use +========== + +To test you can use the following: + +LD_PRELOAD=$(pwd)/lemoncake.so <prog> + +To get some debug output, try this: + +LD_PRELOAD=$(pwd)/lemoncake.so LEMONCAKE_DEBUG=1 <prog> +and then check out lemoncake.out. + +Notes +===== + +Using LD_PRELOAD might break certain programs. Emacs for example +fails to run with any replacement allocator due to the way that it +saves and restores its state.