-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
<div align="center"> | ||
<img height="100" src="assets/logo.png"/> | ||
<h2> TUI for <a href="https://lobste.rs"> lobste.rs </a> website </h2> | ||
</div> | ||
|
||
## 🚀 Installation | ||
|
||
### 📥 Binary release | ||
|
||
You can download the pre-built binaries from the release page [release page](https://github.com/pythops/lobtui/releases) | ||
|
||
### 📦 crates.io | ||
|
||
You can install `lobtui` from [crates.io](https://crates.io/crates/lobtui) | ||
|
||
```shell | ||
cargo install lobtui | ||
``` | ||
|
||
### ⚒️ Build from source | ||
|
||
Run the following command: | ||
|
||
```shell | ||
git clone https://github.com/pythops/lobtui | ||
cd lobtui | ||
cargo build --release | ||
``` | ||
|
||
Then run `strip` to reduce the size of the binary | ||
|
||
```shell | ||
strip target/release/lobtui | ||
``` | ||
|
||
This will produce an executable file at `target/release/lobtui` that you can copy to a directory in your `$PATH`. | ||
|
||
|
||
## 🪄 Usage | ||
|
||
`j` or `Down` : scroll down | ||
|
||
`k` or `Up`: scroll up | ||
|
||
`n`: next page | ||
|
||
`p`: previous page | ||
|
||
`r`: reload the current page | ||
|
||
`o`: open the highlighted story in the browser | ||
|
||
|
||
## ⚖️ License | ||
|
||
GPLv3 |