libmpm

morphux C package management library
Log | Files | Refs | Submodules | README | LICENSE | git clone https://git.ne02ptzero.me/git/libmpm

README.md (1859B)


      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/libmpm"><img src="https://travis-ci.org/Morphux/libmpm.svg?branch=master"/></a> &nbsp;
      8 <a href="https://scan.coverity.com/projects/morphux-libmpm">
      9   <img alt="Coverity Scan Build Status"
     10        src="https://scan.coverity.com/projects/11577/badge.svg"/>
     11 </a>&nbsp;
     12 <a href="https://codecov.io/gh/Morphux/libmpm">
     13   <img src="https://codecov.io/gh/Morphux/libmpm/branch/master/graph/badge.svg" alt="Codecov" />
     14 </a>
     15 <br />
     16 <h1 align="center" style="border:none">Morphux/libmpm</h1>
     17 <h6 align="center">Morphux C Package Management 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/libmpm.git
     27 ```
     28 
     29 ### Init
     30 ```
     31 make init
     32 ```
     33 
     34 ### Compile
     35 By default, the Makefile will create a ready-to-use library, containing the
     36 following:
     37 - libmpm
     38 - libcurl
     39 - json
     40 - sqlite
     41 - libconfuse
     42 
     43 The result is roughly ~20MB
     44 ```
     45 make
     46 ```
     47 
     48 If you want to compile just the libmpm library:
     49 ```
     50 make single
     51 ```
     52 Single lib is about 74Ko
     53 
     54 # Test
     55 ```
     56 valgrind
     57 ```
     58 
     59 ### Basic Tests
     60 ```
     61 make check
     62 ```
     63 
     64 ### Memory Tests
     65 ```
     66 make -C tests valgrind
     67 ```
     68 
     69 ### Coverage
     70 ```
     71 make coverage
     72 ```
     73 
     74 # Use
     75 Compile with the following options
     76 ```
     77 gcc [...] -Llibmpm/ -lmpm -pthread -ldl -Ilibmpm/inc 
     78 ```
     79 Of course, ```libmpm``` directory must exist.
     80 
     81 In code:
     82 ```C
     83 #include <libmpm.h>
     84 ```
     85 
     86 # Documentation
     87 ### Dependencies
     88 ```
     89 doxygen
     90 ```
     91 
     92 Generate it:
     93 ```
     94 make doc
     95 ```