prose/README.md
Naman Sood 969291afcd readme: clarify license
Signed-off-by: Naman Sood <mail@nsood.in>
2023-09-13 01:47:08 -04:00

23 lines
1 KiB
Markdown

# Prose
Prose is a blogging platform written in Go, which I am building to serve my own blog.
## Setup
As of July 2023, `libsass` is no longer available, so the environment running this binary must have access to `sass` on the PATH.
## Usage
Blog posts should be created in the format `title-slug.md`. Work in progress posts should be stored as `WIP-title-slug.md`. Static content should be stored in the `static/` folder, appropriately arranged.
Posts will be served as `/title-slug`, and files like `static/random/file/structure.txt` will be served as `/random/file/structure.txt`. When title slugs and static files conflict, slugs will have higher precdence. An RSS feed of the blog is available at `/rss.xml`.
To start the server:
go run .
Server will be live on port 8080.
## License
The code in this repository (everything other than the contents of `posts/` and `static/`) is licensed under the MIT license; see LICENSE.md. The blog posts themselves are licensed under [CC-BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/).