lib

morphux C utility library
Log | Files | Refs | Submodules | README | LICENSE | git clone https://git.ne02ptzero.me/git/lib

commit e66fca83521cedee43a2dc3c3eb2046da877f9c7
parent 0887cae496fbd2a61f039daf8dadaa72fe8d4fa0
Author: Louis <louis@ne02ptzero.me>
Date:   Thu, 19 Jan 2017 18:11:28 +0100

Update README.md
Diffstat:
MREADME.md | 60++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 58 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md @@ -1,2 +1,58 @@ -# lib -Morphux C Libraries +<p align="center"> +<img src="https://raw.githubusercontent.com/Morphux/Graphic/master/logo/single_penguin.png" /><br /> +</p> +<p align="center"> +<img src="https://img.shields.io/badge/language-c-blue.svg" /> &nbsp; +<img src="https://img.shields.io/badge/license-Apache--2.0-yellow.svg" /> &nbsp; +<a href="https://travis-ci.org/Morphux/lib"><img src="https://travis-ci.org/Morphux/lib.svg?branch=master"/></a> &nbsp; +<a href="https://scan.coverity.com/projects/lib"> + <img alt="Coverity Scan Build Status" + src="https://scan.coverity.com/projects/11517/badge.svg"/> +</a> +<br /> +<h1 align="center" style="border:none">Morphux/lib</h1> +<h6 align="center">Morphux C Development Library</h6> +</p> +<p align="center"> +<a href="#install">Install</a> • <a href="#test">Test</a> • <a href="#use">Use</a> • <a href="#documentation">Documentation</a> +</p> + +# Install +### Clone the repository +``` +git clone https://github.com/Morphux/lib.git +``` + +### Compile +``` +make +``` + +# Test +### Dependencies +``` +valgrind +``` +### Basic Tests +``` +make -C tests check +``` +### Memory Tests +``` +make -C tests valgrind +``` + +# Use +Compile with the following options +``` +gcc [...] -Llib/ -lmorphux -Ilib/inc +``` +Of course, ```lib``` directory must exist. + +In code: +```C +#include <morphux.h> +``` + +### Documentation +TBD.