Skip to content

Add a short "Quick Start" section to the README for common actions #1840

@VNel

Description

@VNel

While the README already points users to man htop and the built-in help for a complete list of commands, it currently does not contain a short, immediately visible overview of the most commonly used actions.

For new users, it could be helpful to add a small “Quick Start” section directly to the README that lists a few frequent actions such as:

  • searching / filtering processes

  • sorting by CPU or memory

  • switching to tree view

  • killing a process

This section would not replace the manual, but complement it by giving beginners a quick entry point before referring them to man htop for full documentation.

Definition of Ready (DoR):

  • The scope is limited to a small README addition

  • No functional changes to htop itself are required

  • The content focuses only on common default actions and keys

  • The full manual (man htop) remains the primary reference

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation 📖Improvements or additions to documentationneeds-discussion 🤔Changes need to be discussed and require consent

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions