libansilove

Library for converting ANSI, ASCII, and other formats to PNG
Log | Files | Refs | README | LICENSE

commit 31e4b9d7c7b168871d4fde2b9b21ce2d9878ec38
parent 4e26f94367b5c8cd71a5c2e2ec43bf0a46cf1dcd
Author: Frederic Cambus <fred@statdns.com>
Date:   Fri, 28 Sep 2018 23:24:43 +0200

Add initial documentation

Diffstat:
AREADME.md | 57+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 57 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md @@ -0,0 +1,57 @@ +# libansilove [![Build Status][1]][2] + +libansilove is a library to converts ANSi and artscene related file formats +into PNG images. + +# Dependencies + +libansilove uses the `CMake` build system and requires the `GD` library and +header files. + +# Installing dependencies + +- OpenBSD: `pkg_add -r cmake gd` +- NetBSD: `pkgin install cmake gd` +- FreeBSD: `pkg install cmake gd` +- Mac OS X: `brew install cmake gd` +- Alpine Linux: `apk add cmake gcc make musl-dev gd-dev` +- Debian / Ubuntu / Mint: `apt-get install cmake libgd-dev` +- Solus: `eopkg install -c system.devel` and `eopkg install gd-devel` + +# Compiling + + cmake . + make + +# Installation + + make install + +# Features + +The following formats are supported: + +- .ANS - ANSi (ANSI escape sequences: ANSI X3.64 standard) +- .PCB - PCBoard Bulletin Board System (BBS) own file format +- .BIN - Binary format (raw memory copy of text mode video memory) +- .ADF - Artworx format, supporting custom character sets and palettes +- .IDF - iCE Draw format, supporting custom character sets and palettes +- .TND - TundraDraw format, supporting 24-bit color mode +- .XB - The eXtended Binary XBin format, supporting custom character sets and palettes + +# Documentation + +# Who pulls the strings + +libansilove is developed by Stefan Vogt ([@ByteProject](https://github.com/ByteProject)), Brian Cassidy ([@bricas](https://github.com/bricas)) and Frederic Cambus ([@fcambus](https://github.com/fcambus)). + +# License + +libansilove is released under the BSD 2-Clause License. See the file `LICENSE` for details. + +# Resources + +GitHub: https://github.com/ansilove/libansilove + +[1]: https://api.travis-ci.org/ansilove/libansilove.png?branch=master +[2]: https://travis-ci.org/ansilove/libansilove