ADD README.md and LICENSE

This commit is contained in:
Stephen Seo 2024-06-04 12:13:12 +09:00
parent 7b0af73a06
commit cff3628798
2 changed files with 37 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Stephen Seo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# AnotherMemCheck
This software was created as an alternative to valgrind/memcheck.
## Usage
1. Build this software with cmake.
2. Assuming the output library is called `libAnotherMemCheck.so`, run your
program with the `LD_PRELOAD` environment variable set to this library.
LD_PRELOAD=path/libAnotherMemCheck.so ./myProgram
3. When the program exits, there should be diagnostic output from this library
showing all memory that has been `malloc`ed and not `free`ed. Note that some
memory will always be shown as having been not `free`ed (e.g. initializing
heap stuff for the program at start).