Permalink
Browse files

added markdown read me

  • Loading branch information...
1 parent a333423 commit 511ae14f73972c4f827cd53c887adb487407f3cd @ByteProject ByteProject committed Oct 17, 2011
Showing with 31 additions and 0 deletions.
  1. +31 −0 README.md
View
@@ -0,0 +1,31 @@
+# AnsiLove.framework
+
+This is a Cocoa framework for rendering ANSi art. It uses a modified version of Frederic Cambus' awesome [AnsiLove](http://ansilove.sourceforge.net) as library. Note that the AnsiLove.framework creates PNG images from ANSi source files, any generated output will be read-only.
+
+# Careful
+
+What we got here is all very experimental right now, so I recommend not using it yet.
+
+# Features
+
+- ANSi (.ANS) format support
+- PCBOARD (.PCB) format support
+- BiNARY (.BIN) format support
+- ADF (.ADF) format support (Artworx)
+- iDF (.IDF) format support (iCE Draw)
+- TUNDRA (.TND) format support [details](http://tundradraw.sourceforge.net)
+- XBiN (.XB) format support [details](http://www.acid.org/info/xbin/xbin.htm)
+- Small output file size (4-bit PNG)
+- SAUCE (Standard Architecture for Universal Comment Extentions)
+- 80x25 font support
+- 80x50 font support
+- Amiga font support
+- iCE colors support
+
+# Charsets
+
+IBM PC (Code page 437), Baltic (Code page 775), Cyrillic (Code page 855), French Canadian (Code page 863), Greek (Code pages 737 and 869), Hebrew (Code page 862), Icelandic (Code page 861), Latin-1 (Code page 850), Latin-2 (Code page 852), Nordic (Code page 865), Portuguese (Code page 860), Russian (Code page 866), Turkish (Code page 857), Armenian (unofficial), Persian / Iran system encoding (unofficial)
+
+## License
+
+The framework is released under the [GNU General Public License version 2](http://www.gnu.org/licenses/gpl-2.0.html).

0 comments on commit 511ae14

Please sign in to comment.