aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 28 insertions, 4 deletions
diff --git a/README.md b/README.md
index 13ee0f7..abbd1a9 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,31 @@
-# libft
+# libft [![Build Status](https://api.travis-ci.com/HappyTramp/libft.svg?branch=master)](https://travis-ci.com/HappyTramp/libft)
-The state of this repo when I pass can be checked with the [raw](http://github.com/HappyTramp/libft/tree/raw) tag.
+libft is an extension/remake of the standard library.
-I have both the pre 2019 and current functions. There is also my [get\_nex\_line](http://github.com/HappyTramp/get_next_line) and [ft\_printf](http://github.com/HappyTramp/ft_printf) in the mix.
+## Getting Started
-The [rendu](http://github.com/HappyTramp/libft/tree/rendu) branch is the one I use for my other projects, it doesnt contain .gitignore, README.md and subjects.
+```
+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.
+
+### School turn in
+
+The state of this project when I turned it in for correction is [here](http://github.com/HappyTramp/libft/tree/raw).