Skip to content

Commit

Permalink
Adding more description to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
berrystephenw committed Mar 4, 2022
1 parent 2f4535b commit 1743edc
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This is an adaptation of the original UNIX fortune program. Fortune will
run on OctoPrint login and popup a quote or saying from a database of stored quotes.

I have not created these quotes or sayings, they are simply provided from the
source given by Brian M. Clapper as a sample set of fortunes.
source given by Brian M. Clapper as a sample set of fortunes, and Joel Kirchartz for the additional fortune files:

http://software.clapper.org/fortune/

https://github.com/JKirchartz/fortunes

There is an icon that looks like a book on the navigation bar for those that
would like a more frequent fortune. This can be turned off in the settings page.

Expand All @@ -22,14 +24,14 @@ This is a Python 3 or greater plugin!

## Configuration

The configuration available are:
The configuration options available are:
* to enable or disable the icon on the navigation bar
* optionally enable sending your fortune to OctoText. [OctoText](https://plugins.octoprint.org/plugins/OctoText/) must be enabled and configured for
this feature to work.

<img width="320" alt="Fortune" src="octoprint_fortune/assets/img/fortune-text.png">

* option to use a fixed delay on the fortune popups. The default is based on
* option to use a fixed delay on the fortune popups. The default delay is based on
the number of characters in the fortune.
* select the fortune file out of the following list:
* authors
Expand Down

0 comments on commit 1743edc

Please sign in to comment.