1
0
mirror of https://github.com/mrusme/neonmodem.git synced 2024-11-03 04:27:16 -05:00
neonmodem/README.md
2023-01-06 20:10:45 -05:00

1.3 KiB

Neon Modem Overdrive

Neon Modem Overdrive is a BBS-like command line client that supports Discourse, Lemmy, Lobsters and Hacker News as backends and seamlessly integrates all of them into a streamlined TUI. And yes, you heard that right, I really called it Neon Modem Overdrive.

Neon Modem is built in Go, using Charm's Bubbletea TUI framework, but implements an own window manager (or compositor if you want) that allows it to use a third dimension, on top of the two dimensional rendering that Bubbletea offers today. With that it is possible to display dialogs on top of one another, in order to offer a smoother UI experience.

Build

To build this software, simply run make within the cloned repository:

make

The binary is called neonmodem

Setup

Before launching Neon Modem Overdrive, it requires initial setup of the services (a.k.a. systems). Run neonmodem --help to find out more.