Added installation instructions
This commit is contained in:
parent
491f442697
commit
1667fb10ef
1 changed files with 41 additions and 11 deletions
52
README.md
52
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 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.
|
- Build a lightweight website with zero JavaScript.
|
||||||
- Write your pages in Markdown or HTML.
|
- Simple CLI build interface.
|
||||||
- Automatic RSS/Atom feed generation.
|
- HTML layout optimized for screen readers and Neocities.
|
||||||
- HTML layout optimized for screen readers.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Dependencies
|
### 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
|
## Roadmap
|
||||||
|
|
||||||
- [ ] Zona configuration file to define build options.
|
- [ ] Zona configuration file to define build options.
|
||||||
- [ ] Image optimization & dithering options.
|
- [ ] Image optimization & dithering options.
|
||||||
- [ ] AUR package after first release
|
- [ ] AUR package after first release
|
||||||
|
- [ ] Automatic RSS/Atom feed generation.
|
||||||
|
|
||||||
## Inspirations
|
## Inspirations
|
||||||
|
|
||||||
- [Zoner](https://git.sr.ht/~ryantrawick/zoner)
|
- [Zoner](https://git.sr.ht/~ryantrawick/zoner)
|
||||||
- Zonelets
|
- Zonelets
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue