mirror of
https://git.sr.ht/~yotam/shavit
synced 2024-05-09 15:36:02 +02:00
Give the project a proper name
This commit is contained in:
parent
0490a6a0ff
commit
7316ce78a2
14
README.md
14
README.md
|
@ -1,9 +1,9 @@
|
|||
# Go Gemini Server
|
||||
# Shavit
|
||||
|
||||
This is a yet to be named configurable Gemini server for UNIX operating systems.
|
||||
The server is in a very early state and can only serve static files but in the
|
||||
near future it will support dynamically generated files like a search endpoints
|
||||
and an Atom feed.
|
||||
Shavit is a configurable Gemini server for UNIX operating systems. The server
|
||||
is in a very early state and can only serve static files but in the near future
|
||||
it will support dynamically generated files like a search endpoints and an Atom
|
||||
feed.
|
||||
|
||||
## Building
|
||||
|
||||
|
@ -11,12 +11,12 @@ The server is written in Go so to build it you only need to run one command:
|
|||
|
||||
go build
|
||||
|
||||
This will produce a binary named `go-gemini-server` that you can run.
|
||||
This will produce a binary named `shavit` that you can run.
|
||||
|
||||
## Running
|
||||
|
||||
After you have compiled the server you need to configure it before it will run.
|
||||
The server expect a configuration file in `/etc/gemini/config.toml` that contain
|
||||
The server expect a configuration file in `/etc/shavit/config.toml` that contain
|
||||
a path to the documents directory and the certificate files. A simple
|
||||
configuration file might look like this:
|
||||
|
||||
|
|
2
go.mod
2
go.mod
|
@ -1,4 +1,4 @@
|
|||
module git.sr.ht/~yotam/go-gemini-server
|
||||
module git.sr.ht/~yotam/shavit
|
||||
|
||||
go 1.12
|
||||
|
||||
|
|
Loading…
Reference in New Issue