ChaoticByte/plaintext-encyclopedia
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Require .txt filename extension for entries, allow defining entry title via Title: ... in first line of the file, update examples

Browse source
This commit is contained in:
ChaoticByte 2025-07-11 21:32:16 +02:00
parent 1db5336f35
commit 89fbb17ab7
No known key found for this signature in database
6 changed files with 53 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -8,12 +8,25 @@ A very simple and clean reader/browser? for plaintext... documentation? wiki? ch
## How to use
1. Set your settings in `settings.go`
2. Modify (if you want)
2. Modify the application (if you want)
3. Compile `go get && go build -o server`
4. Place your content into `entries/`
4. Place your `.txt` files into `entries/` (see section "Formatting" below)
5. Run `./server`
6. put behind a proxy (or don't).
### Formatting
The only formatting option you have: to define a title.
```
Title: A title
here comes the entry body ...
```
It has to be defined in the first line of the text file.
If you don't define a title, the filename without the `.txt` part gets used as the title.
## Requirements
Developed and tested on Linux. Should work on other Unixoids.