diff --git a/README.md b/README.md index 826998b..1a2ac4d 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,53 @@ A port of [figlet](http://www.figlet.org/) to golang. Make it easier to use,add some new feature such as colorized outputs. -##Install - go get -u github.com/getwe/figlet4go - ##Usage +###Install + go get -u github.com/getwe/figlet4go + +###Demo +```go +package main + +import ( + "fmt" + "github.com/fatih/color" + "github.com/getwe/figlet4go" +) + +func main() { + str := "golang" + ascii := figlet4go.NewAsciiRender() + // most simple Usage + renderStr, _ := ascii.Render(str) + fmt.Println(renderStr) + + // change the font color + options := figlet4go.NewRenderOptions() + options.FontColor = make([]color.Attribute, len(str)) + options.FontColor[0] = color.FgMagenta + options.FontColor[1] = color.FgYellow + options.FontColor[2] = color.FgBlue + options.FontColor[3] = color.FgCyan + options.FontColor[4] = color.FgRed + options.FontColor[5] = color.FgWhite + renderStr, _ = ascii.RenderOpts(str, options) + fmt.Println(renderStr) + + // change the font + options.FontName = "larry3d" + // except the default font,others need to be load from disk + // here is the font : + // ftp://ftp.figlet.org/pub/figlet/fonts/contributed.tar.gz + // ftp://ftp.figlet.org/pub/figlet/fonts/international.tar.gz + // download and extract to the disk,then specify the file path to load + ascii.LoadFont("/usr/local/Cellar/figlet/2.2.5/share/figlet/fonts/") + + renderStr, _ = ascii.RenderOpts(str, options) + fmt.Println(renderStr) + +} +``` + +![screenshot](./screenshot/demo1.jpg) diff --git a/figlet/buildinfont.go b/buildinfont.go similarity index 99% rename from figlet/buildinfont.go rename to buildinfont.go index c0ac287..5103c8f 100644 --- a/figlet/buildinfont.go +++ b/buildinfont.go @@ -1,4 +1,4 @@ -package figlet +package figlet4go // Build in source font func buildInFont() string { diff --git a/demo/demo.go b/demo/demo.go new file mode 100644 index 0000000..d60a259 --- /dev/null +++ b/demo/demo.go @@ -0,0 +1,40 @@ +package main + +import ( + "fmt" + "github.com/fatih/color" + "github.com/getwe/figlet4go" +) + +func main() { + str := "golang" + ascii := figlet4go.NewAsciiRender() + // most simple Usage + renderStr, _ := ascii.Render(str) + fmt.Println(renderStr) + + // change the font color + options := figlet4go.NewRenderOptions() + options.FontColor = make([]color.Attribute, len(str)) + options.FontColor[0] = color.FgMagenta + options.FontColor[1] = color.FgYellow + options.FontColor[2] = color.FgBlue + options.FontColor[3] = color.FgCyan + options.FontColor[4] = color.FgRed + options.FontColor[5] = color.FgWhite + renderStr, _ = ascii.RenderOpts(str, options) + fmt.Println(renderStr) + + // change the font + options.FontName = "larry3d" + // except the default font,others need to be load from disk + // here is the font : + // ftp://ftp.figlet.org/pub/figlet/fonts/contributed.tar.gz + // ftp://ftp.figlet.org/pub/figlet/fonts/international.tar.gz + // download and extract to the disk,then specify the file path to load + ascii.LoadFont("/usr/local/Cellar/figlet/2.2.5/share/figlet/fonts/") + + renderStr, _ = ascii.RenderOpts(str, options) + fmt.Println(renderStr) + +} diff --git a/figlet/font.go b/font.go similarity index 99% rename from figlet/font.go rename to font.go index 758175e..0e14985 100644 --- a/figlet/font.go +++ b/font.go @@ -1,4 +1,4 @@ -package figlet +package figlet4go import ( "errors" diff --git a/figlet/render.go b/render.go similarity index 99% rename from figlet/render.go rename to render.go index 36a9d0a..226471a 100644 --- a/figlet/render.go +++ b/render.go @@ -1,4 +1,4 @@ -package figlet +package figlet4go import ( "errors" diff --git a/screenshot/demo1.jpg b/screenshot/demo1.jpg new file mode 100644 index 0000000..ac7859c Binary files /dev/null and b/screenshot/demo1.jpg differ