diff --git a/README.md b/README.md index cd071a6..edefcfd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ # hugo-theme-readable -Hugo theme built using readable.css from Freedom to Write -https://codeberg.org/Freedom-to-Write/readable.css \ No newline at end of file +Readable is a theme for the static-site generator [Hugo](https://gohugo.io/) using the [readable.css](https://readable-css.freedomtowrite.org/) framework built by [Freedom to Write](https://freedomtowrite.org/). + +Shoutout to [Benjamin Hollon](https://benjaminhollon.com/) for his amazing work building this CSS framework and making it so simple to use. + +Want to check out a demo? (coming soon) + +![demo image](/docs/demo_image.png) + +## Installation + +To add this theme to an existing Hugo site, start by adding this repo as a submodule in the site's themes folder. + +`git submodule add https://github.com/cjtheham/hugo-theme-readable themes/readable` + +Then, update your config file to be using the new theme. For example, if you are using config.toml, the line should become: + +`theme = 'readable'` + +If you don't have an existing site, feel free to use the provided [starter template](https://github.com/cjtheham/hugo-starter-readable) to quickly get your website online. + +For more information on starting a Hugo website and using custom themes, refer to the [Hugo documentation](https://gohugo.io/documentation/). + +## Usage + +Freedom to Write has provided some awesome guides on writing HTML that works automatically with the formatting of Readable. For a complete HTML page guide on writing custom pages, see [Overall Structure](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Overall-Structure). For some neat tips that may make life easier working with this style sheet, read [Quick Tips](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Quick-Tips). + +## Notes + +- Benjamin loves when new sites and projects pop up using the readable.css framework! + - If you've built a complete site using this theme, submit an issue to the [original repo](https://codeberg.org/Freedom-to-Write/readable.css) with the URL of your site to be featured in the project's README. + - Projects like this and other non-website uses of the framework, such as adapting it to other static site generators, can be featured on the page[Unofficial Related Projects (that are awesome)](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Unofficial-Related-Projects-%28that-are-awesome%29). Go mention @freedomtowrite@fosstodon.org to be featured there! \ No newline at end of file diff --git a/docs/demo_image.png b/docs/demo_image.png new file mode 100644 index 0000000..1b91287 Binary files /dev/null and b/docs/demo_image.png differ