From 403034d462bd0b98d3896571aa15e8d404659099 Mon Sep 17 00:00:00 2001 From: randogoth Date: Mon, 20 Oct 2025 22:19:58 +0300 Subject: [PATCH] install info --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a92e83f..c8fefb1 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,12 @@ $$ | $$ | $$ |\$$$$$$$ |$$$$$$$$\   \$$$$  |$$  /\$$\   \$$$$  This repository contains the `md2txt` command line tool and supporting libraries for transforming Markdown into arcane formats that work well on retro hardware or constrained text viewers. A small plugin API lets you mix-and-match parsers and renderers so additional formats can plug into the same preprocessing pipeline. +Install the CLI directly from GitHub with [uv](https://github.com/astral-sh/uv): + +``` +uv tool install --from github:randogoth/md2txt md2txt +``` + ## CLI - `md2txt` – converts Markdown into plain text with extensive formatting support. It ships with the default `markdown` parser and `text` renderer plugins, registers optional `micron`, `ama`, and `gemini` renderers for Micron/Ancient Machine Book or Gemtext output, and exposes the core pipeline so you can add your own parser or renderer modules: @@ -148,4 +154,4 @@ The shared preprocessing helpers—YAML frontmatter parsing, recursive include e --- * Directed and vibe coded by Tobias Raayoni Last -* Programming by gpt-5-codex \ No newline at end of file +* Programmed by `gpt-5-codex`