https://github.com/linguini1/help-text

Utility for generating help text for C command line tools from a plain-text input.
https://github.com/linguini1/help-text

c cli command-line command-line-tool command-line-utility help help-text plaintext utility

Last synced: 28 days ago
JSON representation

Utility for generating help text for C command line tools from a plain-text input.

• Host: GitHub
• URL: https://github.com/linguini1/help-text
• Owner: linguini1
• License: mit
• Created: 2024-08-15T23:58:05.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-15T23:59:45.000Z (3 months ago)
• Last Synced: 2024-08-16T01:00:33.903Z (3 months ago)
• Topics: c, cli, command-line, command-line-tool, command-line-utility, help, help-text, plaintext, utility
• Language: C
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# help-text

A tool for turning plain-text into an include-able `#define` for C projects. The primary purpose of this utility is to

turn a help text document into printable help text from within C for command line utilities with a `--help` option.

## Building

Clone the git repository and make:

```console

git clone https://github.com/linguini1/help-text.git

cd help-text

make all

```

## Usage

For usage hints, call `help-text -h`. Yes, this utility's help text was generated using itself.

Once complete, you can include the generated help text macro in your C project. Here are two valid ways of generating

the help text macro.

```console

cat myhelptext.txt | help-text > myhelptext.h

help-text -i myhelptext.txt -o myhelptext.h

```

You can use the `-I` flag of your compiler to include your generated help text header file as part of your build

process, or you can include it directly with the `#include` directive.