ansigo

Simple ANSi to PNG converter written in pure Go
Log | Files | Refs | README | LICENSE

README.md (1563B)


      1 # AnsiGo
      2 
      3 ## Description
      4 
      5 AnsiGo is a simple ANSi to PNG converter written in pure Go. It converts files
      6 containing ANSi sequences (.ANS) into PNG images.
      7 
      8 For a multi-format general purposes converter and library, check out Ansilove
      9 instead: https://www.ansilove.org
     10 
     11 ## Features
     12 
     13 - ANSi (.ANS) format support
     14 - Small output file size (4-bit PNG)
     15 - 80x25 font support: IBM PC (Code page 437) charset
     16 
     17 ## Installation
     18 
     19 Build and install with the `go` tool:
     20 
     21 	go build ansigo
     22 	go install ansigo
     23 
     24 Alternatively, you can easily cross-compile binaries for other systems. See the `Cross-compiling AnsiGo binaries` section for instructions.
     25 
     26 ## Usage
     27 
     28 AnsiGo takes the input file as parameter:
     29 
     30 	ansigo inputfile
     31 
     32 ## Cross-compiling AnsiGo binaries
     33 
     34 Building Go for the required platform:
     35 
     36 	cd /usr/local/go/
     37 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 ./make.bash
     38 	CGO_ENABLED=0 GOOS=windows GOARCH=amd64 ./make.bash
     39 
     40 Building Linux binaries:
     41 
     42 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o linux/amd64/ansigo ansigo
     43 	CGO_ENABLED=0 GOOS=linux GOARCH=386 go build -o linux/i386/ansigo ansigo
     44 
     45 Building Windows binaries:
     46 
     47 	CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o windows/amd64/ansigo.exe ansigo
     48 	CGO_ENABLED=0 GOOS=windows GOARCH=386 go build -o windows/i386/ansigo.exe ansigo
     49 
     50 ## License
     51 
     52 AnsiGo is released under the BSD 2-Clause license. See `LICENSE` file for details.
     53 
     54 ## Author
     55 
     56 AnsiGo is developed by Frederic Cambus.
     57 
     58 - Site: https://www.cambus.net
     59 
     60 ## Resources
     61 
     62 GitHub: https://github.com/fcambus/ansigo
     63 
     64 Sister project: https://www.ascii-codes.com