Finally update README.md

Finally update README.md
This commit is contained in:
Eric 2015-07-15 08:56:02 -07:00
parent 068e6d2297
commit d6e5df0767
1 changed files with 33 additions and 0 deletions

View File

@ -1 +1,34 @@
# 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 -
```c++
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
```c++
#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 <span style="color:#009900;">*dark green*</span> and num in <span style="color:#00FF00;">*light green*</span>