lib

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

README.md (1507B)


      1 <p align="center">
      2 <img src="https://raw.githubusercontent.com/Morphux/Graphic/master/logo/single_penguin.png" /><br />
      3 </p>
      4 <p align="center">
      5 <img src="https://img.shields.io/badge/language-c-blue.svg" /> &nbsp;
      6 <img src="https://img.shields.io/badge/license-Apache--2.0-yellow.svg" /> &nbsp;
      7 <a href="https://travis-ci.org/Morphux/lib"><img src="https://travis-ci.org/Morphux/lib.svg?branch=master"/></a> &nbsp;
      8 <a href="https://scan.coverity.com/projects/lib">
      9   <img alt="Coverity Scan Build Status"
     10        src="https://scan.coverity.com/projects/11517/badge.svg"/>
     11 </a>&nbsp;
     12 <a href="https://codecov.io/gh/Morphux/lib">
     13   <img src="https://codecov.io/gh/Morphux/lib/branch/master/graph/badge.svg" alt="Codecov" />
     14 </a>
     15 <br />
     16 <h1 align="center" style="border:none">Morphux/lib</h1>
     17 <h6 align="center">Morphux C Development Library</h6>
     18 </p>
     19 <p align="center">
     20 <a href="#install">Install</a> • <a href="#test">Test</a> • <a href="#use">Use</a> • <a href="#documentation">Documentation</a>
     21 </p>
     22 
     23 # Install
     24 ### Clone the repository
     25 ```
     26 git clone https://github.com/Morphux/lib.git
     27 ```
     28 
     29 ### Compile
     30 ```
     31 make
     32 ```
     33 
     34 # Test
     35 ### Dependencies
     36 ```
     37 valgrind
     38 ```
     39 ### Basic Tests
     40 ```
     41 make -C tests check
     42 ```
     43 ### Memory Tests
     44 ```
     45 make -C tests valgrind
     46 ```
     47 
     48 # Use
     49 Compile with the following options
     50 ```
     51 gcc [...] -Llib/ -lmorphux -Ilib/inc 
     52 ```
     53 Of course, ```lib``` directory must exist.
     54 
     55 In code:
     56 ```C
     57 #include <morphux.h>
     58 ```
     59 
     60 # Documentation
     61 ### Dependencies
     62 ```
     63 doxygen
     64 ```
     65 
     66 Generate it:
     67 ```
     68 make doc
     69 ```