KevinMidboe/motdGO
1
0
Fork 0
mirror of https://github.com/KevinMidboe/motdGO.git synced 2025-10-29 17:50:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change repo name

Browse Source
This commit is contained in:
Maxi Binder
2017-08-30 15:18:29 +02:00
committed by GitHub
parent 9c68bf1dfe
commit bf47f79c6d
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,6 +1,6 @@
# FIGlet for Go # FIGlet for Go
[![Go Report Card](https://goreportcard.com/badge/github.com/probandula/figlet4go)](https://goreportcard.com/report/github.com/probandula/figlet4go) [![Go Report Card](https://goreportcard.com/badge/github.com/mbndr/figlet4go)](https://goreportcard.com/report/github.com/mbndr/figlet4go)
`figlet4go` is a go library forked from which is a port of [FIGlet](http://www.figlet.org/) to Golang. `figlet4go` is a go library forked from which is a port of [FIGlet](http://www.figlet.org/) to Golang.
With `figlet4go` it's easy to create **ascii text banners** in the command-line or with the given api. With `figlet4go` it's easy to create **ascii text banners** in the command-line or with the given api.
@@ -13,7 +13,7 @@ With `figlet4go` it's easy to create **ascii text banners** in the command-line
## Installation ## Installation
``` ```
$ go get -u github.com/probandula/figlet4go/... $ go get -u github.com/mbndr/figlet4go/...
``` ```
## Usage ## Usage
@@ -29,7 +29,7 @@ For a usage instruction read the commands usage with `figlet4go -h`.
### Basic ### Basic
You have to create a renderer (`ascii`) and let it render the desired string through the `Render` method. After that you can simply print the returned string. You have to create a renderer (`ascii`) and let it render the desired string through the `Render` method. After that you can simply print the returned string.
```go ```go
import "github.com/probandula/figlet4go" import "github.com/mbndr/figlet4go"
// ... // ...
@@ -45,7 +45,7 @@ The colors given in the `[]figlet4go.Color` slice are repeating if the string is
If you use a `TrueColor` color, you have to ensure that your [terminal supports](https://gist.github.com/XVilka/8346728/) it. If you use a `TrueColor` color, you have to ensure that your [terminal supports](https://gist.github.com/XVilka/8346728/) it.
If you use a `AnsiColor` with an `TrueColor` only parser (f.e. `ParserHTML`), `TrueColor` objects are automatically generated. If you use a `AnsiColor` with an `TrueColor` only parser (f.e. `ParserHTML`), `TrueColor` objects are automatically generated.
```go ```go
import "github.com/probandula/figlet4go" import "github.com/mbndr/figlet4go"
// ... // ...
@@ -72,7 +72,7 @@ fmt.Print(renderStr)
If you want to use another font, you have to specify the name of the font as in this example. If you want to use another font, you have to specify the name of the font as in this example.
Is the font you want to use not [included](#builtin) you have to load the font manually with the `LoadFont` method. This method will walk the path recursively and load all `.flf` files. Is the font you want to use not [included](#builtin) you have to load the font manually with the `LoadFont` method. This method will walk the path recursively and load all `.flf` files.
```go ```go
import "github.com/probandula/figlet4go" import "github.com/mbndr/figlet4go"
// ... // ...
@@ -91,7 +91,7 @@ fmt.Print(renderStr)
### Other parser ### Other parser
A Parser can be set through the `GetParser` function with a valid key A Parser can be set through the `GetParser` function with a valid key
```go ```go
import "github.com/probandula/figlet4go" import "github.com/mbndr/figlet4go"
// ... // ...