From 4bd4fe5aac023919ccc1cb31be64c2f0600f5509 Mon Sep 17 00:00:00 2001 From: Gene Johnson Date: Thu, 19 Mar 2026 11:44:00 -0700 Subject: [PATCH] docs: add table of contents to README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 83227d6..1e1d9f3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,36 @@ A full-screen terminal news ticker that renders live global headlines in large O --- +## Contents + +- [Using](#using) + - [Run](#run) + - [Config](#config) + - [Feeds](#feeds) + - [Fonts](#fonts) + - [Color Schemes](#color-schemes) + - [ntfy.sh](#ntfysh) + - [Figment Mode](#figment-mode) +- [Internals](#internals) + - [How it works](#how-it-works) + - [Architecture](#architecture) +- [Extending](#extending) + - [NtfyPoller](#ntfypoller) + - [MicMonitor](#micmonitor) + - [Render pipeline](#render-pipeline) +- [Development](#development) + - [Setup](#setup) + - [Tasks](#tasks) + - [Testing](#testing) + - [Linting](#linting) +- [Roadmap](#roadmap) + - [Performance](#performance) + - [Graphics](#graphics) + - [Cyberpunk Vibes](#cyberpunk-vibes) + - [Extensibility](#extensibility) + +--- + ## Using ### Run