Elgato_dark/tiki
1
0
Fork 0
mirror of https://github.com/boolean-maybe/tiki synced 2026-04-21 13:37:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add terminal requirements

Browse source
This commit is contained in:
booleanmaybe 2026-01-22 00:40:55 -05:00
parent a253e25dd2
commit df71463553
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -38,6 +38,28 @@ and simply copy the `tiki` executable to any location and make it available via
tiki --version
```
## Terminal Requirements
`tiki` CLI tool works best with modern terminal emulators that support:
- **TrueColor (24-bit color)** for gradient rendering
- **UTF-8 encoding** for proper character display
- Standard ANSI escape sequences
### Recommended Terminals
- **macOS**: iTerm2, kitty, Alacritty, or default Terminal.app
- **Linux**: kitty, Alacritty, GNOME Terminal, Konsole, or any xterm-256color compatible terminal
- **Windows**: Windows Terminal, ConEmu, or Alacritty
### Terminal Configuration
For best results, ensure your terminal is set to:
- TERM environment variable: `xterm-256color` or better (e.g., `xterm-truecolor`)
- UTF-8 encoding enabled
If colors don't display correctly, try setting:
```bash
export TERM=xterm-256color
```
## Quick start
`cd` into your **git** repo and run `tiki`.
@ -108,4 +130,4 @@ to contribute:
![Build Status](https://github.com/boolean-maybe/tiki/actions/workflows/go.yml/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/boolean-maybe/tiki)](https://goreportcard.com/report/github.com/boolean-maybe/tiki)
[![Go Reference](https://pkg.go.dev/badge/github.com/boolean-maybe/tiki.svg)](https://pkg.go.dev/github.com/boolean-maybe/tiki)
[![Go Reference](https://pkg.go.dev/badge/github.com/boolean-maybe/tiki.svg)](https://pkg.go.dev/github.com/boolean-maybe/tiki)