textpic

README

text-pic

This tool generates a social media-friendly graphic from some text. It's especially made to be paired with WriteFreely, a minimalist blogging platform.

Usage

To run this, you'll need Go installed. With that, you can compile the project:

go get github.com/writeas/text-pic/cmd/wfgraphic-cli

Then you can run wfgraphic-cli with the options below.

Usage of wfgraphic-cli:
  -font string
        Post font (options: "serif", "sans", "mono") (default "serif")
  -h string
        WriteFreely instance hostname (e.g. "pencil.writefree.ly")
  -o string
        Image output filename (default "out.png")
  -size string
        Image size, either a single number for a square (e.g. "900") or a combined width and height (e.g. "1080x1920") (default "1024")
  -u string
        WriteFreely author username (for multi-user instances)

The actual content of the graphic is read from stdin, which you can either supply when prompted to, or pipe in, for example:

cat quote.txt | ./wfgraphic-cli -h write.as -u blog

Examples

Documentation

Index

• func GenerateImage(opt *ContentOptions, w, h int, outputFilename string) error
• func IsValidFont(f string) bool
• type ContentOptions
  • func NewContentOptions(instance, username string, isSubdomain bool, font, content string) *ContentOptions

Functions

func GenerateImage

func GenerateImage(opt *ContentOptions, w, h int, outputFilename string) error

func IsValidFont

func IsValidFont(f string) bool

Types

type ContentOptions

type ContentOptions struct {
	// Author information
	Instance string
	Username string

	// Write.as-only option
	IsSubdomain bool // UNIMPLEMENTED

	// Content
	UserFont string
	Content  string
}

func NewContentOptions

func NewContentOptions(instance, username string, isSubdomain bool, font, content string) *ContentOptions