2018-12-25 21:39:23 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.14" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > identiconpp: Main Page< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > identiconpp
2018-12-26 19:25:03 +01:00
  < span id = "projectnumber" > 0.1.2< / span >
2018-12-25 21:39:23 +01:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > identiconpp Documentation< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < p > < b > identiconpp< / b > is a library to generate identicons. Written in C++.< / p >
2018-12-26 19:25:03 +01:00
< p > You get the images as < code > Magick::Image< / code > . This allows you to make all kinds of modifications.< / p >
2018-12-25 21:39:23 +01:00
< h2 > Features< / h2 >
2018-12-26 19:25:03 +01:00
< ul >
< li > [x] Simple identicons< / li >
< li > [ ] libravatar/sigil identicons< / li >
< / ul >
2018-12-26 04:40:04 +01:00
< h2 > Usage< / h2 >
< p > The HTML reference can be generated with build_doc.sh, if doxygen is installed. It is also available at < a href = "https://doc.schlomp.space/identiconpp/classIdenticonpp.html" > doc.schlomp.space/identiconpp/< / a > .< / p >
2018-12-26 19:25:03 +01:00
< h3 > Example< / h3 >
< div class = "fragment" > < div class = "line" > {C++}< / div > < div class = "line" > // Compile with g++ $(Magick++-config --cppflags --ldflags) -lidenticonpp< / div > < div class = "line" > #include < identiconpp.hpp> < / div > < div class = "line" > #include < Magick++/Image.h> < / div > < div class = "line" > < / div > < div class = "line" > int main()< / div > < div class = "line" > {< / div > < div class = "line" > Identiconpp identicon(5, 5, Identiconpp::identicon_type::simple,< / div > < div class = "line" > " ffffff88" , { " 800000ff" });< / div > < div class = "line" > Magick::Image img;< / div > < div class = "line" > img = identicon.generate(" 55502f40dc8b7c769880b10874abc9d0" , 200);< / div > < div class = "line" > img.write(" identicon.png" );< / div > < div class = "line" > }< / div > < / div > <!-- fragment --> < h2 > Install< / h2 >
< h3 > Gentoo< / h3 >
< p > Gentoo ebuilds are available via my < a href = "https://schlomp.space/tastytea/overlay" > repository< / a > .< / p >
< h3 > Automatically generated packages< / h3 >
< p > Binary packages are generated automatically for each < a href = "https://schlomp.space/tastytea/identiconpp/releases" > release< / a > in the formats:< / p >
< ul >
< li > deb< / li >
< li > rpm< / li >
< li > tar.gz< / li >
< / ul >
< p > They are generated on Debian Stretch 64 bit and signed with my < a href = "https://tastytea.de/tastytea_autosign.asc" > automatic signing key< / a > .< / p >
2018-12-25 21:39:23 +01:00
< h3 > From source< / h3 >
< h4 > Dependencies< / h4 >
< ul >
< li > C++ compiler (tested: < a href = "https://gcc.gnu.org/" > gcc< / a > 5/6/7/8, < a href = "https://llvm.org/" > clang< / a > 5/6)< / li >
< li > < a href = "https://cmake.org/" > cmake< / a > (at least 3.2)< / li >
< li > < a href = "https://www.imagemagick.org/" > imagemagick< / a > (tested: 7.0 / 6.7)< / li >
< / ul >
2018-12-26 19:25:03 +01:00
< p > On a Debian system, install the packages: < code > build-essential cmake libmagick++-dev< / code > .< / p >
2018-12-25 21:39:23 +01:00
< h4 > Compile< / h4 >
< div class = "fragment" > < div class = "line" > mkdir build< / div > < div class = "line" > cd build< / div > < div class = "line" > cmake ..< / div > < div class = "line" > make< / div > < div class = "line" > make install< / div > < / div > <!-- fragment --> < h5 > cmake options< / h5 >
< ul >
< li > < code > -DCMAKE_BUILD_TYPE=Debug< / code > for a debug build< / li >
2018-12-26 19:25:03 +01:00
< li > One of:< ul >
< li > < code > -DWITH_DEB=YES< / code > to generate a deb-package< / li >
< li > < code > -DWITH_RPM=YES< / code > to generate an rpm-package< / li >
< / ul >
< / li >
2018-12-25 21:39:23 +01:00
< / ul >
2018-12-26 19:25:03 +01:00
< p > To generate a binary package, execute < code > make package< / code > < / p >
2018-12-25 21:39:23 +01:00
< h2 > Contributing< / h2 >
< p > Contributions are always welcome. You can submit them as pull requests or via email to < code > tastytea< / code > < tt> tastytea.de.< / p >
< h2 > Contact< / h2 >
< p > See < a href = "https://tastytea.de/" > https://tastytea.de/< / a > < / p >
< h2 > License & Copyright< / h2 >
< div class = "fragment" > < div class = "line" > Copyright © 2018 tastytea < tastytea@tastytea.de> .< / div > < div class = "line" > License GPLv3: GNU GPL version 3 < https://www.gnu.org/licenses/gpl-3.0.html> .< / div > < div class = "line" > This program comes with ABSOLUTELY NO WARRANTY. This is free software,< / div > < div class = "line" > and you are welcome to redistribute it under certain conditions.< / div > < / div > <!-- fragment --> < / div > < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.14
< / small > < / address >
< / body >
< / html >