README.md
1# Rearx
2A TUI client for the Searx meta-search engine, written in Rust
3
4# How to use it
5Write rearx + "search query" on your terminal.
6
7# Keybinds
8Right arrow -> Go to next page\
9Left arrow -> Go to previous page\
10f -> Go to first page\
11q -> Quit\
12[0-9] -> opens the search result corresponding to the pressed number key
13
14
15# Installation
16On Arch Linux and derivatives, you can install from the AUR like this: yay -S rearx-bin
17
18On other distros you can install from source by cloning this repo and executing cargo build --release (the only requirement here is to have cargo installed)
19
20Mandatory:
21In order to use Rearx, you first need to create the folder /etc/rearx/ and copy the rearx.yaml configuration file in there. Inside this file, you specify which instance of Searxyou will connect to
22
23WARNING: bear in mind that, if the Searx instance you are connecting to has very strict firewall rules regarding json, Rearx will panic! on "rate limit exceeded"
24
25# Platforms
26Only Linux is officially supported. Windows support is not planned nor possible because the program depends on the termion crate. It might compile on MacOS, but you are on your own.
27
28# Example screenshot
29
30
31
){kind=link}