muhammadmuzzammil1998/catsay

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# catsay 
[![Build Status](https://travis-ci.org/muhammadmuzzammil1998/catsay.svg?branch=master)](https://travis-ci.org/muhammadmuzzammil1998/catsay) [![CodeFactor](https://www.codefactor.io/repository/github/muhammadmuzzammil1998/catsay/badge)](https://www.codefactor.io/repository/github/muhammadmuzzammil1998/catsay) [![Go Report Card](https://goreportcard.com/badge/github.com/muhammadmuzzammil1998/catsay)](https://goreportcard.com/report/github.com/muhammadmuzzammil1998/catsay) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/800d49d519784954ad0051d8c23a34c4)](https://www.codacy.com/app/muhammadmuzzammil1998/catsay?utm_source=github.com&utm_medium=referral&utm_content=muhammadmuzzammil1998/catsay&utm_campaign=Badge_Grade) [![Maintainability](https://api.codeclimate.com/v1/badges/1ce5d0c70611a65a5036/maintainability)](https://codeclimate.com/github/muhammadmuzzammil1998/catsay/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1ce5d0c70611a65a5036/test_coverage)](https://codeclimate.com/github/muhammadmuzzammil1998/catsay/test_coverage) [![GitHub license](https://img.shields.io/github/license/muhammadmuzzammil1998/catsay.svg)](https://github.com/muhammadmuzzammil1998/catsay/blob/master/LICENSE) [![Twitter](https://img.shields.io/twitter/url/https/github.com/muhammadmuzzammil1998/catsay.svg?style=social)](https://twitter.com/intent/tweet?hashtags=catsay&text=Take%20a%20look%20at%20this!%20CatSay%20by%20@mmuzzammil1998&url=https://github.com/muhammadmuzzammil1998/catsay/)

**catsay** is a program that generates pictures of a cat holding a sign with a message. 
![image](.github/images/front.png)

## Build
Requires [git](https://git-scm.com/download/win) to clone and [Go](https://golang.org/dl/) to build.
```bash
$ git clone https://github.com/muhammadmuzzammil1998/catsay.git
$ cd catsay
$ go get -d
$ go build
```

## Installation
Follow the guide on the [releases](https://github.com/muhammadmuzzammil1998/catsay/releases) page for detailed instructions.
### Linux
Download `.deb` file for catsay from the [releases](https://github.com/muhammadmuzzammil1998/catsay/releases) page.
```bash
$ wget https://github.com/muhammadmuzzammil1998/catsay/releases/download/{version}/catsay-linux-{amd64/386}.deb
$ sudo dpkg -i catsay-linux-{amd64/386}.deb
```
### Windows
Start PowerShell as an admin
```ps
$ Invoke-WebRequest https://github.com/muhammadmuzzammil1998/catsay/releases/download/{version}/catsay-windows-{amd64/386}.exe -OutFile catsay.exe
$ mv .\catsay.exe C:\Windows\catsay.exe
```
### Other OSs
You can download the [binary already built](https://github.com/muhammadmuzzammil1998/catsay/releases) for your system or [build it yourself](https://github.com/muhammadmuzzammil1998/catsay#build).

### NOTE: This should be obvious but still:
 - Adapt `{version}` number. Check version number from [here](https://github.com/muhammadmuzzammil1998/catsay/releases).
 - Choose your architecture, `amd64` for 64 bit and `386` for 32 bit systems.

## Usage
Pipe the data you want your cat to say.
### Examples
![image](.github/images/example.png)

## Seeing blocks instead of eyes, nose, or hand?
This is probably because your terminal doesn't support those characters. lulz.

Try `catsay -ascii` to use ASCII-only characters. 
![image](.github/images/ascii.png)

## Help
![image](.github/images/help.png)

## Uninstall
### Linux
```bash
$ sudo dpkg --remove catsay
```
### Windows
Start PowerShell as an admin
```ps
$ del C:\Windows\catsay.exe
```
## Contributors

- **[@mattn](https://github.com/mattn)** - Fixed width for multi-byte strings *([#14](https://github.com/muhammadmuzzammil1998/catsay/pull/14))*