Added un-marked up README file

This commit is contained in:
R. Eric Wheeler 2015-07-15 11:39:34 -07:00
parent a7553a28e0
commit 62d3201851
1 changed files with 41 additions and 0 deletions

41
README Normal file
View File

@ -0,0 +1,41 @@
*******************
** libpipecolors **
*******************
This library parses input like printf and sprintf but instead of returning a
boring string it will replace renegade bbs style pipecodes (|09) with their
ansi equivelent.
**************************
** It has two functions **
**************************
int pcprintf(const char * format, ...);
int pcsprintf(char * str, const char * format, ...);
***********
** To Do **
***********
[x] Remove std::map requirement
[ ] Remove boost requirement without forcing -std=c++11
*****************
** Example use **
*****************
#include <cstdio>
#include <iostream>
#include <pipecolors.h>
using namespace pipecolors;
int main(void) {
int num = 5;
const char* str = "My number is";
pcprintf("|02%s |10%d|39\n", str, num);
return 0;
}
This would return \x1b[0;32mMy number is \x1b[0;92m5\x1b[0;39m\n, Printing str in dark green and num in light green