Skip to content

Commit 9b48503

Browse files
github-throwawayidank
authored andcommitted
Update README.md
1 parent 0b660cf commit 9b48503

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
explainshell is a tool (with a web interface) capable of parsing man pages, extracting options and
44
explaining a given command-line by matching each argument to the relevant help text in the man page.
55

6+
> [!IMPORTANT]
7+
> ### ⚠️ Note on Maintenance and Manpages
8+
>
9+
> This project is actively maintained in terms of keeping it healthy and functional — issues are addressed, and the core remains stable.
10+
>
11+
> 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.
12+
>
13+
> 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.
14+
15+
616
## How?
717

818
explainshell is built from the following components:

0 commit comments

Comments
 (0)