# Summary

**Scuttleblog** creates a blog from a [Scuttlebutt][] journal, using [Scuttlebot][] and [Hugo][].

[Scuttlebutt]: https://www.scuttlebutt.nz/
[Scuttlebot]: http://scuttlebot.io/
[Hugo]: https://gohugo.io/


# How to use it

## Set up

1. On Ubuntu 17.10: install using install.sh.
2. Enter your Scuttlebutt user identity into conf.py.


## Update the blog

Periodically:

1. Run scuttleblog.py.
2. (Optionally, run `hugo server` from inside hugo/ and view a preview with Hugo's internal web server.)
3. Sync the contents of hugo/public/ to your server.


# How it works

* Scuttleblog starts Scuttlebot, and uses it to fetch the specified identity's posts and metadata.
* It manipulates the data into the format Hugo expects for a blog.
* Then it runs Hugo to generate the blog.