From 7d45bd6bfd7248847b9108154653223814a5429f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9E=E3=83=AA=E3=82=A6=E3=82=B9?= Date: Fri, 6 Jan 2023 20:10:45 -0500 Subject: [PATCH] Updated README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9040aca..7e9ee54 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,39 @@ -neonmodem ------ +Neon Modem Overdrive +-------------------- + +[*Neon Modem Overdrive*][neonmodem] is a BBS-like command line client that +supports [Discourse][discourse], [Lemmy][lemmy], [Lobsters][lobsters] and +[Hacker News][hackernews] 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][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. + +[neonmodem]: https://neonmodem.com +[discourse]: https://github.com/discourse +[lemmy]: https://github.com/LemmyNet +[lobsters]: https://github.com/lobsters/lobsters +[hackernews]: https://news.ycombinator.com +[bubbletea]: https://github.com/charmbracelet/bubbletea +## Build + +To build this software, simply run `make` within the cloned repository: + +```sh +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. +