mirror of
https://github.com/mrusme/neonmodem.git
synced 2024-11-03 04:27:16 -05:00
Updated README.md
This commit is contained in:
parent
7d45bd6bfd
commit
a24f2b7a8c
100
README.md
100
README.md
@ -32,8 +32,102 @@ make
|
||||
The binary is called `neonmodem`
|
||||
|
||||
|
||||
## Setup
|
||||
## Configuration
|
||||
|
||||
Before launching *Neon Modem Overdrive*, it requires initial setup of the
|
||||
services (a.k.a. *systems*). Run `neonmodem --help` to find out more.
|
||||
Before launching *Neon Modem Overdrive* it requires initial setup of the
|
||||
services (a.k.a. *systems*). Run `neonmodem connect --help` to find out more.
|
||||
|
||||
Connecting a service will add it to the configuration TOML, usually under
|
||||
`~/.config/neonmodem.toml`.
|
||||
|
||||
|
||||
### Systems
|
||||
|
||||
#### Discourse
|
||||
|
||||
For connecting to a Discourse instance you'll need to have an active account on
|
||||
that instance. *Neon Modem* will store the instance URL, username and a user
|
||||
key, but no password.
|
||||
|
||||
```sh
|
||||
neonmodem connect --type discourse --url https://www.keebtalk.com
|
||||
```
|
||||
|
||||
|
||||
#### Lemmy
|
||||
|
||||
For connecting to a Lemmy instance you'll need to have an active account on that
|
||||
instance. *Neon Modem* will store the instance URL, username and password.
|
||||
|
||||
```sh
|
||||
neonmodem connect --type lemmy --url https://lemmy.ml
|
||||
```
|
||||
|
||||
|
||||
#### Lobsters
|
||||
|
||||
For connecting to a Lobsters instance you won't need an account, as the
|
||||
integration is read-only. *Neon Modem* will store the instance URL.
|
||||
|
||||
```sh
|
||||
neonmodem connect --type lobsters --url https://lobste.rs
|
||||
```
|
||||
|
||||
|
||||
#### Hacker News
|
||||
|
||||
For connecting to Hacker News you won't need an account, as the integration is
|
||||
read-only.
|
||||
|
||||
```sh
|
||||
neonmodem connect --type hackernews
|
||||
```
|
||||
|
||||
|
||||
### UI
|
||||
|
||||
The UI can be fully customized via the `Theme` section in the configuration
|
||||
file. To reset settings, all Theme related configurations can simply be deleted
|
||||
from the configuration.
|
||||
|
||||
|
||||
## Run
|
||||
|
||||
After setup *Neon Modem* can be launched by calling `neonmodem` without any
|
||||
arguments. It will briefly display a splash screen, then switch to the posts
|
||||
list, which will aggregate the latest posts from all connected systems. A
|
||||
progress icon will be visible in the header while network requests are loading.
|
||||
|
||||
|
||||
### Navigation
|
||||
|
||||
In the posts list:
|
||||
|
||||
- `j`: Scroll down
|
||||
- `k`: Scroll up
|
||||
- `r`/`enter`: Open selected post
|
||||
- `n`: Write new post in on the system/forum of the current selected post
|
||||
- `C-e`: Open system selector
|
||||
- `C-t`: Open forum selector
|
||||
- `q`/`esc`: Quit
|
||||
|
||||
In the post view dialog:
|
||||
|
||||
- `r`: Reply to post
|
||||
- `#r`: Reply to specific comment # in post, e.g. `3r` to reply to the reply #3
|
||||
- `esc`: Close dialog
|
||||
|
||||
In the new post / new reply dialog:
|
||||
|
||||
- `tab`: Switch between elements (only in new post dialog)
|
||||
- `C-s`: Submit post/reply
|
||||
- `esc`: Close dialog
|
||||
|
||||
|
||||
## FAQ
|
||||
|
||||
- **Q:** The post view is really slow when using a large terminal.\
|
||||
**A:** Turning off image rendering will improve performance significantly on
|
||||
very large terminal windows and can be done by setting `RenderImages = false`
|
||||
in the configuration.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user