Added a README
This commit is contained in:
parent
b3ba50ad26
commit
1aa58ac243
9 changed files with 30 additions and 0 deletions
19
README.md
Normal file
19
README.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Plaintext Encyclopedia
|
||||
|
||||
A very simple and clean reader/browser? for plaintext... documentation? wiki? chapters of a book? whatever.
|
||||
|
||||

|
||||

|
||||
|
||||
## How to use
|
||||
|
||||
1. Set your settings in `settings.go`
|
||||
2. Modify (if you want)
|
||||
3. Compile `go get && go build -o server`
|
||||
4. Place your content into `entries/`
|
||||
5. Run `./server`
|
||||
6. put behind a proxy (or don't).
|
||||
|
||||
## Requirements
|
||||
|
||||
Developed and tested on Linux. Should work on other Unixoids.
|
Reference in a new issue