Updated README.md

pull/34/head
マリウス 2 years ago
parent 0435efd200
commit e3740cc651
No known key found for this signature in database
GPG Key ID: 272ED814BF63261F

@ -135,7 +135,8 @@ effect on the next launch of Superhighway84.
Configuration options that might be of interest:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- superhighway84.toml - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArticlesListView =
The view to be used for the articles lit. Possible values:
0 - threaded view, latest thread at the top
@ -152,6 +153,18 @@ ArticlesListView =
[Shortcuts]
The shortcuts for navigating Superhighway84, can be reset to its defaults by
simply removing the whole [Shortcuts] block and launching Superhighway84
The structure is as following:
`<key code> = "event"`
The key codes can be looked up under the following link:
https://pkg.go.dev/github.com/gdamore/tcell/v2#Key
For simple ASCII characters use their ASCII code, e.g. `114` for the character
`r`.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -177,16 +190,42 @@ C-l, C-k: Focus articles list
r: Reply to selected article
However, you are free to customize these within your configuration file, under
the section `Shortcuts`. The structure is as following:
the section `Shortcuts`.
SUBMIT ARTICLE
When submitting a new article or a reply to an article, the $EDITOR is launched
in which a document with a specific structure will be visible. This structure
consists of the HEADER, a SEPARATOR and the BODY and looks like this:
- $EDITOR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Subject: This is the subject of the article
Newsgroup: test.sandbox
= = = = = =
This is the multiline
body of the article
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
The HEADER contains all headers that are required for an article to be
submitted. These are:
`<key code> = "event"`
- Subject:
The subject of the article that will be shown in the articles list. The
subject must only contain of printable ASCII characters.
The key codes can be looked up under the following link:
- Newsgroup:
The newsgroup under which the article will be submitted, this can
either be an existing group or a new group. Please try to follow
the convention when creating new groups.
The newsgroup must only contain of printable ASCII characters.
https://pkg.go.dev/github.com/gdamore/tcell/v2#Key
The SEPARATOR contains of 6 equal signs and 5 spaces, alternating each
other, followed by a new line.
For simple ASCII characters use their ASCII code, e.g. `114` for the character
`r`.
The BODY can contain of multiline text.

Loading…
Cancel
Save