From abe4eabd5b24e708888530d9a9d44a768a69e289 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20S?=
 <32925813+neoski@users.noreply.github.com>
Date: Tue, 10 Apr 2018 00:45:00 +0200
Subject: [PATCH] Create README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a8de3bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# libc-assembly
+16 libc (C standard library) functions recoded in assembly (bzero, memcpy, memmove, memset, 
+rindex, strcasecmp, strchr, strcmp, strcpy, strcspn, strlen, strncmp, strnlen,
+strpbrk, strrchr, strstr);
+
+**Requirements :**
+
+gcc
+nasm
+
+**Usage :**
+
+1. git clone https://github.com/neoski/libc-assembly.git
+
+2. cd libc-assembly && make
+
+3. You can use the `libasm.so`
+
+A script is provided (`test.sh`) which compile C files testing the functions 
+in a hidden directory (`.test_files`) and make a `diff` of the standard output 
+and the one generated when the lib is loaded.
+
+To run it : `./test.sh`
+
+*Note : The current Makefile is correctly setted for MAC OS X.
+For Linux, change `CFLAGS = -f macho64` to `CFLAGS = -f elf64`.
+
+**Authors :** Sebastien S. and Benoit Sida
+
+**Github repository :** https://github.com/neoski/libc-assembly
+
+**Made in april 2016.**