1
0
mirror of https://github.com/mrusme/neonmodem.git synced 2024-06-16 06:25:23 +00:00

Updated README.md

This commit is contained in:
マリウス 2023-01-11 00:04:22 -05:00
parent 0d1d63460d
commit 4539684c79
No known key found for this signature in database

View File

@ -26,15 +26,42 @@ of one another, in order to offer a smoother UI experience.
[bubbletea]: https://github.com/charmbracelet/bubbletea
## Build
## Installation
To build this software, simply run `make` within the cloned repository:
### From Release
Download the [latest
release](https://github.com/mrusme/neonmodem/releases/latest) and unpack
it:
```sh
$ tar -xzf ./neonmodem_*.tar.gz
```
The binary is called `neonmodem`. Feel free to move it to e.g. `/usr/local/bin`.
### From Sauce
Clone this repository
- from [GitHub](https://github.com/mrusme/neonmodem)
```sh
$ git clone git@github.com:mrusme/neonmodem.git
```
- from
[Radicle](https://app.radicle.network/seeds/willow.radicle.garden/rad:git:hnrkqhjb9a9nhooegxzkhnp1jdb8p3j9wfzwy)
```sh
$ rad clone rad://maple.radicle.garden/hnrkcf9617a8pxxtw8caaop9ioe8cj5u4c4co
```
Then cd into the cloned directory and run:
```sh
make
```
The binary is called `neonmodem`
The binary is called `neonmodem`. Feel free to move it to e.g. `/usr/local/bin`.
## Configuration
@ -48,6 +75,7 @@ Connecting a service will add it to the configuration TOML, usually under
### Systems
#### Discourse
For connecting to a Discourse instance you'll need to have an active account on