mirror of
https://github.com/KevinMidboe/motdGO.git
synced 2025-10-29 09:40:23 +00:00
readme changes, other default font, go-bindata for default font, little commenting
This commit is contained in:
50
README.md
50
README.md
@@ -1,32 +1,34 @@
|
||||
# figlet4go
|
||||
_______ __ _______ __ _______ .___________. _ _ _______ ______
|
||||
| ____|| | / _____|| | | ____|| || || | / _____| / __ \
|
||||
| |__ | | | | __ | | | |__ `---| |----`| || |_ | | __ | | | |
|
||||
| __| | | | | |_ | | | | __| | | |__ _| | | |_ | | | | |
|
||||
| | | | | |__| | | `----.| |____ | | | | | |__| | | `--' |
|
||||
|__| |__| \______| |_______||_______| |__| |_| \______| \______/
|
||||
# FIGlet for Go
|
||||
|
||||
A port of [figlet](http://www.figlet.org/) to golang.
|
||||
Make it easier to use,add some new feature such as colorized outputs.
|
||||
**Currently in Development.
|
||||
Sould work but will be improved (add demos, better font adding, maybe better performance, more default fonts)**
|
||||
|
||||
A port of [figlet](http://www.figlet.org/) to golang and fork of [getwe/figlet4go](https://github.com/getwe/figlet4go).
|
||||
|
||||

|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
go get -u github.com/probandula/figlet4go
|
||||
```
|
||||
|
||||
## Usage
|
||||
```go
|
||||
// Create the renderer
|
||||
ascii := figlet4go.NewAsciiRender()
|
||||
|
||||
// Optional: Add color to the letters (https://github.com/fatih/color needed)
|
||||
|
||||
### Install
|
||||
|
||||
```
|
||||
go get -u github.com/getwe/figlet4go
|
||||
// Render and print the string
|
||||
renderStr, _ := ascii.Render("Hello World")
|
||||
fmt.Print(renderStr)
|
||||
```
|
||||
|
||||
### Demo
|
||||
## Default font
|
||||
The default font is built into the `bindata.go` file with the tool [go-bindata](https://github.com/jteeuwen/go-bindata).
|
||||
The bash script for building the default font is stored in `tools/` (`go-bindata` must be installed).
|
||||
|
||||
```
|
||||
cd demo/
|
||||
go build
|
||||
./demo -str="golang"
|
||||
#Maybe you have to `brew install figlet` if you need 3D fond in mac osx.
|
||||
```
|
||||
|
||||
see details in `demo/demo.go` .
|
||||
|
||||

|
||||
## Use the demo
|
||||
There are [demo](https://github.com/probandula/figlet4go/blob/master/demo) programs for trying out the library.
|
||||
To run them, `cd` into the `demo/` directory and run `go run [filename]` on any program you want to run.
|
||||
Reference in New Issue
Block a user