mirror of
https://github.com/GeopJr/BLAHAJ.git
synced 2025-01-22 16:46:56 +01:00
142 lines
6 KiB
Markdown
142 lines
6 KiB
Markdown
<p align="center">
|
|
<img width="512" alt="BLÅHAJ ascii art in trans flag colors" src="./logo.svg">
|
|
</p>
|
|
<h1 align="center">BLÅHAJ</h1>
|
|
<h4 align="center">Gay sharks at your local terminal</h4>
|
|
<p align="center">
|
|
<br />
|
|
<a href="https://github.com/GeopJr/BLAHAJ/blob/main/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.1-ffffff.svg?style=for-the-badge&labelColor=5992a4" alt="Code Of Conduct" /></a>
|
|
<a href="https://github.com/GeopJr/BLAHAJ/blob/main/LICENSE"><img src="https://img.shields.io/badge/LICENSE-BSD--2--Clause-ffffff.svg?style=for-the-badge&labelColor=5992a4" alt="BSD-2-Clause" /></a>
|
|
<a href="https://github.com/GeopJr/BLAHAJ/actions"><img src="https://img.shields.io/github/workflow/status/GeopJr/BLAHAJ/Specs%20&%20Lint/main?labelColor=5992a4&style=for-the-badge" alt="ci action status" /></a>
|
|
</p>
|
|
|
|
#
|
|
|
|
## What is BLÅHAJ?
|
|
|
|
Apart from [a cute cuddly shark plushie from IKEA](https://www.ikea.com/us/en/p/blahaj-soft-toy-shark-90373590/), BLÅHAJ is a lolcat-like CLI tool that colorizes your input, shows flags and prints colorful sharks!
|
|
|
|
It has a wide variety of flags/colors to choose from and many options from flag size to whether to colorize by line, word or character.
|
|
|
|
#
|
|
|
|
## Installation
|
|
|
|
### Pre-built
|
|
|
|
You can download one of the statically-linked pre-built binaries from the [releases page](https://github.com/GeopJr/BLAHAJ/releases/latest).
|
|
|
|
They are built & published by our lovely [actions](https://github.com/GeopJr/BLAHAJ/actions/workflows/release.yml).
|
|
|
|
### Building
|
|
|
|
#### Dependencies
|
|
|
|
- `crystal` - `1.4.1`
|
|
|
|
#### Makefile
|
|
|
|
- `$ make` (or `$ make static` on Alpine Linux for a static build)
|
|
- `# make install`
|
|
|
|
#
|
|
|
|
## FAQ
|
|
|
|
### Why are only striped flags allowed?
|
|
|
|
Flags with eg. triangles, circles or symbols, need enough horizontal space to determine where and how to display them. BLÅHAJ can't know in advance how long the input is going to be.
|
|
|
|
### Why are the stripes repeating instead of showing the flag in full?
|
|
|
|
Just like the previous question, BLÅHAJ can't know how long the text is going to be (vertically) since it colorizes the input as it comes in.
|
|
|
|
### I would like to add a color scheme or flag
|
|
|
|
Great! Follow the [Contributing section](#contributing) and modify [data/colors.json](./data/colors.json).
|
|
|
|
```json
|
|
{
|
|
"flag/color scheme name": [
|
|
"color",
|
|
"per",
|
|
"stripe"
|
|
],
|
|
"alias for scheme (if any)": "flag/color scheme name"
|
|
}
|
|
```
|
|
|
|
#
|
|
|
|
## Examples
|
|
|
|
```
|
|
$ blahaj -h
|
|
|
|
BLÅHAJ v1.0.0
|
|
|
|
Usage:
|
|
blahaj [arguments]
|
|
blahaj [arguments] file
|
|
command | blahaj [arguments]
|
|
|
|
Examples:
|
|
blahaj -f trans ~/.bashrc
|
|
blahaj -s -b
|
|
neofetch | blahaj -f gay
|
|
blahaj -f lesbian -m 4
|
|
blahaj -- -w /etc/os-release
|
|
|
|
Arguments:
|
|
-b, --background Color the background
|
|
-f, --flag Return a flag
|
|
-s, --shark Shork
|
|
-i, --individual Color individual characters
|
|
-w, --words Color individual words
|
|
-m MULTIPLIER, --multiplier=MULTIPLIER
|
|
Multiplier for the flag size (-f)
|
|
-c FLAG, --colors=FLAG Color scheme to use (Default: trans)
|
|
--flags List all available flags
|
|
-h, --help Show this help
|
|
```
|
|
|
|
### Shark (`-s`), flag (`-f`), flag with 2x multiplier (`-f -m 2`)
|
|
|
|
|
|
|
|
### Pipe, individual characters instead of rows (`-i`)
|
|
|
|
|
|
|
|
### Read from file, background instead of foreground (`-b`), individual words instead of rows (`-w`)
|
|
|
|
> Notice how the foreground color changes based on the background color.
|
|
|
|
|
|
|
|
### Pipe, default color scheme
|
|
|
|
|
|
|
|
> All images above include ALT text and you are encouraged to read it, if you find parts of them confusing, by using screen readers, hovering over them with your cursor or looking at the source.
|
|
|
|
#
|
|
|
|
## Contributing
|
|
|
|
1. Read the [Code of Conduct](https://github.com/GeopJr/BLAHAJ/blob/main/CODE_OF_CONDUCT.md)
|
|
2. Fork it ( https://github.com/GeopJr/BLAHAJ/fork )
|
|
3. Create your feature branch (git checkout -b my-new-feature)
|
|
4. Commit your changes (git commit -am 'Add some feature')
|
|
5. Push to the branch (git push origin my-new-feature)
|
|
6. Create a new Pull Request
|
|
|
|
#
|
|
|
|
## Sponsors
|
|
|
|
<p align="center">
|
|
|
|
[](https://github.com/sponsors/GeopJr)
|
|
|
|
</p>
|