From 697d3366f3189a727d499295a0670865833b57fa Mon Sep 17 00:00:00 2001 From: Malte <25488086+github-throwaway@users.noreply.github.com> Date: Fri, 23 May 2025 15:32:50 +0200 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e2a690c4..7640287c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ explainshell is a tool (with a web interface) capable of parsing man pages, extracting options and explaining a given command-line by matching each argument to the relevant help text in the man page. +> [!IMPORTANT] +> ### ⚠️ Note on Maintenance and Manpages +> +> This project is actively maintained in terms of keeping it healthy and functional — issues are addressed, and the core remains stable. +> +> However, please note that the **manpages are outdated**. The previous system for generating them was unsustainable, and they haven’t been updated in some time. There are currently **no active plans** to revise this mechanism. +> +> If you're relying on manpages, be aware that they may not reflect the latest behavior. Contributions in this area are welcome but would require rethinking the documentation pipeline. + + ## How? explainshell is built from the following components: