diff --git a/README.md b/README.md index 196d2f8..de4acce 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,66 @@ Zona is a small tool for building a static blog website. It allows users to write pages and blog posts in Markdown and automatically build them into a static, lightweight blog. -Zona is quite opinionated about the website structure, since I am mainly building it for my own use. However, this may change as the project develops. +> **Warning:** Implementing v1 functionality in Go is still WIP. While this warning is here, Zona is _not_ ready to use! At all! -> **Warning:** Implementing bare minimum basic functionality in Go is still WIP. While this warning is here, Zona is _not_ ready to use! At all! +## Table of Contents -## Features +- [Features](#v1-features) +- [Installation](#installation) +- [Roadmap](#roadmap) -- Simple CLI build interface. +## v1 Features + +- Write your pages in Markdown. - Build a lightweight website with zero JavaScript. -- Write your pages in Markdown or HTML. -- Automatic RSS/Atom feed generation. -- HTML layout optimized for screen readers. +- Simple CLI build interface. +- HTML layout optimized for screen readers and Neocities. ## Getting Started ### Dependencies -TBD. +- `go 1.23.2` -### Build +```Bash +# On Arch Linux +sudo pacman -S go -TBD. +# On Ubuntu/Debian +sudo apt install go +``` + +### Installation + +First, download the repository and open it: + +```Bash +git clone https://github.com/ficcdaf/zona.git && cd zona +``` + +On Linux: + +```Bash +# run the provided build script +./build.sh +``` + +On other platforms: + +```Bash +go build -o bin/zona cmd/zona +``` + +The resulting binary can be found at `bin/zona`. ## Roadmap - [ ] Zona configuration file to define build options. - [ ] Image optimization & dithering options. - [ ] AUR package after first release +- [ ] Automatic RSS/Atom feed generation. ## Inspirations - [Zoner](https://git.sr.ht/~ryantrawick/zoner) - Zonelets -