diff options
Diffstat (limited to 'test_mini/libft/README.md')
| -rw-r--r-- | test_mini/libft/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/test_mini/libft/README.md b/test_mini/libft/README.md new file mode 100644 index 0000000..a278471 --- /dev/null +++ b/test_mini/libft/README.md @@ -0,0 +1,37 @@ +# libft [](https://travis-ci.com/HappyTramp/libft) + +libft is an extension/remake of the standard library. + +## Getting Started + +``` +git clone https://github.com/HappyTramp/libft libft +cd libft +make all +``` + +This will produce a `libft.a` library which you can link to your project. + +## Unit Test + +``` +make test +``` + +## Dependencies + +* [Unity](https://github.com/ThrowTheSwitch/Unity) - unit testing lib + +## .libftignore + +Much like the `.gitignore` file, you can put the files/directory to ignore when compiling. + +## Documentation + +1. Install [Doxygen](http://doxygen.nl/manual/install.html) +2. Run `make doc` +3. Open doc/html/index.html in your browser or read the man in doc/man/man3 + +## School correction state + +The state of this project when I turned it in for correction is [here](http://github.com/HappyTramp/libft/tree/raw). |