HarryR / HarryR/logpipe

Provide better help / usage instructions

Open
#7 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

It was pointed out that the usage information provided by the application doesn't have clear enough instructions to get started, but the documentation in README.md does provide clear enough examples.

Enhance the `show_help` function in logpipe.c to include some examples of pipelines, and some background information describing the concepts behind it (e.g. the buffer, what steps are).

The end result is that after installing the package the user should be able to type `logpipe` and have all the information they need to start experimenting and get something useful out of it.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.