Skip to content
This repository was archived by the owner on Nov 29, 2024. It is now read-only.
This repository was archived by the owner on Nov 29, 2024. It is now read-only.

Add helper manual (-h) option  #55

@noahra

Description

@noahra

Currently, byteblitz lacks a built-in helper manual or usage guide accessible from the command line. This feature is essential for new users or even experienced users who need a quick reference to the tool's functionalities and command syntax. Implementing a -h or --help option would greatly enhance user experience and accessibility.

Feature Request:

I propose adding a -h or --help option to byteblitz. This option should display a concise yet comprehensive guide on how to use byteblitz, including:

A brief description of what byteblitz does.
A list of all available commands and their functionalities.
Examples of common usage scenarios.
Information about other available flags and options (e.g., format switching).

Expected Outcome:

Users can type byteblitz -h or byteblitz --help to access the help manual.
The manual provides clear, useful information that enhances the user experience.
Improved accessibility and ease of use, particularly for new users.
Additional Considerations:

The help manual should be easy to read and well-formatted for command-line display.
It should be kept up-to-date with the latest features and changes in byteblitz.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions