Skip to content

Commit

Permalink
add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pythops committed Jan 17, 2024
1 parent cfb4e94 commit 377c6f5
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions Readme.md
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

0 comments on commit 377c6f5

Please sign in to comment.