From 341ed3ccb7b5f2415a35f56697345c1eb8a77a29 Mon Sep 17 00:00:00 2001 From: Emmanuel Harish Menon Date: Thu, 14 Jan 2021 14:01:56 +1100 Subject: [PATCH] Add issue reporting explanation --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9fa9f5..b47fec3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This project is my attempt at increasing the readability of [Project Gutenberg](https://www.gutenberg.org/)'s HTML books. Results will be a little inconsistent across Gutenberg's catalog because of how Project Gutenberg styles their books, but if you do notice any weirdness, don't hesitate to [open an issue](https://github.com/emmanuelmenon/better-gutenberg/issues/new), or to [submit a pull request](https://github.com/emmanuelmenon/better-gutenberg/compare). ## Installing -You'll need to install Stylus or some sort of userstyle extension. You can install Stylus at any of these links: +You'll need to install [Stylus](https://github.com/openstyles/stylus) or some sort of userstyle extension. You can install Stylus at any of these links: - [Firefox](https://addons.mozilla.org/en-US/firefox/addon/styl-us/) - [Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne) - [Opera](https://addons.opera.com/en-gb/extensions/details/stylus/) @@ -11,6 +11,9 @@ Once Stylus is installed, click on the badge below to install the custom style. [![Install directly with Stylus](https://img.shields.io/badge/Install%20directly%20with-Stylus-00adad.svg)](https://raw.githubusercontent.com/emmanuelmenon/better-gutenberg/main/better-gutenberg.user.css) +## Issues +If you do notice an issue with how a book looks, [open an issue](https://github.com/emmanuelmenon/better-gutenberg/issues/new/choose) and select the appropriate template. Fill it out and hit "Submit new issue". I'll attempt to sort it out as soon as I can! + ## License ``` This is free and unencumbered software released into the public domain.