Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.55 KB

README.md

File metadata and controls

55 lines (32 loc) · 2.55 KB
Raw

Open Author Clock ⏰

An open-source, web-based implementation of the Author Clock Kickstarter project intended to run on any type of device.

✨ See It in Action ✨

Why confine the beautiful words of literature to the pages of a book? This project brings literary quotes to every minute of your day, telling time through the wise and whimsical words of authors from times gone by.

Try it out for yourself and see how literature can tell time: Live Demo Site 🖥️

Inspiration

This adventure was sparked by two main projects:

  • The Author Clock: A dedicated gadget that tells time through literary quotes, offering a new hand-picked passage every minute.

  • The literaryclock repo by elegantalchemist: The brilliant idea of a literary clock already executed on the Kindle Keyboard using Python.

Contributing to the Quote List

If you've stumbled upon a quote that perfectly captures a minute, feel free to contribute!

Quote Formatting

Each quote should be formatted as follows:

time|timestring|quote|title|author

  • time: The specific time the quote represents, in 24-hour format (e.g., 14:45).
  • timestring: The way the time is mentioned within the quote, to be highlighted (e.g., quarter to three).
  • quote: The full sentence from the book where the time is mentioned.
  • title: The title of the book the quote is from.
  • author: The author of the book.

For example: 00:00|midnight|It starts at midnight.|Catching Fire|Suzanne Collins

Where to Add Your Quote

Navigate to the script.js file in the project, and you'll find an string named csvData. Add your formatted quote to this array, following the existing structure.

Known Issues

Visit this repo's Issues page to see known issues and contribute to make this project even better!

License Disclaimer

This project uses quotes sourced from the literaryclock repo under the GNU General Public License v3.0. We adhere to the same license, ensuring:

  • Retention of license and copyright notice.
  • Disclosure of source and state changes.
  • Distribution under the GNU General Public License v3.0.

For detailed license information, please refer to the LICENSE file in this repository.