github/television
1
1
Fork 0
mirror of https://github.com/alexpasmantier/television.git synced 2025-06-06 03:25:23 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs: terminal emulators compatibility and good first issues (#56)

Browse Source 
* docs: terminal emulators compatibility and good first issues

* Update changelog

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Alexandre Pasmantier 2024-11-22 20:06:26 +01:00 committed by GitHub
parent 0f6aad952f
commit cdcce4d9f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -8,9 +8,13 @@ All notable changes to this project will be documented in this file.
- Quote file names that contain spaces when printing them to stdout (#51) - Quote file names that contain spaces when printing them to stdout (#51)
### 📚 Documentation
- Terminal emulators compatibility and good first issues
### ⚙️ Miscellaneous Tasks ### ⚙️ Miscellaneous Tasks
- Add readme version update to github actions - Add readme version update to github actions (#55)
## [0.5.1] - 2024-11-20 ## [0.5.1] - 2024-11-20

14
README.md
View File

@ -1,7 +1,7 @@
<div align="center"> <div align="center">
# 📺 television # 📺 television
**A blazingly fast general purpose fuzzy finder for your terminal written in Rust.** **A blazingly fast general purpose fuzzy finder TUI.**
![docs.rs](https://img.shields.io/docsrs/television-channels) ![docs.rs](https://img.shields.io/docsrs/television-channels)
[![Crates.io](https://img.shields.io/crates/v/television.svg)](https://crates.io/crates/television) [![Crates.io](https://img.shields.io/crates/v/television.svg)](https://crates.io/crates/television)
@ -16,7 +16,7 @@
</div> </div>
## About ## About
`Television` is a blazingly fast general purpose fuzzy finder TUI written in Rust. `Television` is a blazingly fast general purpose fuzzy finder TUI.
It is inspired by the neovim [telescope](https://github.com/nvim-telescope/telescope.nvim) plugin and is designed to be fast, efficient, simple to use and easily extensible. It is built on top of [tokio](https://github.com/tokio-rs/tokio), [ratatui](https://github.com/ratatui/ratatui) and the *nucleo* matcher used by the [helix](https://github.com/helix-editor/helix) editor. It is inspired by the neovim [telescope](https://github.com/nvim-telescope/telescope.nvim) plugin and is designed to be fast, efficient, simple to use and easily extensible. It is built on top of [tokio](https://github.com/tokio-rs/tokio), [ratatui](https://github.com/ratatui/ratatui) and the *nucleo* matcher used by the [helix](https://github.com/helix-editor/helix) editor.
@ -37,7 +37,7 @@ sudo dpkg -i television_0.5.0-1_amd64.deb
pacman -S television pacman -S television
``` ```
#### From the [latest release](https://github.com/alexpasmantier/television/releases/latest) page #### Binary ([latest release](https://github.com/alexpasmantier/television/releases/latest))
- Download the latest release asset for your platform (e.g. `tv-vX.X.X-linux-x86_64.tar.gz` if you're on a linux x86 machine) - Download the latest release asset for your platform (e.g. `tv-vX.X.X-linux-x86_64.tar.gz` if you're on a linux x86 machine)
- Unpack and copy to the relevant location on your system (e.g. `/usr/local/bin` on macos and linux for a global installation) - Unpack and copy to the relevant location on your system (e.g. `/usr/local/bin` on macos and linux for a global installation)
@ -171,6 +171,12 @@ Here is a list of terminal emulators that have currently been tested with `telev
| Terminator | Linux | ✅ | | Terminator | Linux | ✅ |
| Xterm | Linux | ✅ | | Xterm | Linux | ✅ |
| Cmder | Windows | ✖️ | | Cmder | Windows | ✖️ |
| Foot | Linux | ✅ |
| Rio | macOS, Linux, Windows | ✅ |
| Warp | macOS | ✅ |
| Hyper | macOS | ✅ |
## Customization ## Customization
@ -201,4 +207,4 @@ The default configuration file can be found in the repository's [./.config/confi
Contributions, issues and pull requests are welcome. Contributions, issues and pull requests are welcome.
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. See [CONTRIBUTING.md](CONTRIBUTING.md) and [good first issues](https://github.com/alexpasmantier/television/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) for more information.