Provide better help / usage instructions

Open Beginner friendly
#7 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
c
Domain
cli

Research direction

Start in logpipe.c at the show_help function and compare its current output with the examples in README.md. Add pipeline examples and explanations of concepts such as the buffer and steps, then run logpipe after installation to verify that its help provides enough information to begin experimenting.

Written by the indexing model from the issue text.

Description

enhancement

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.

Dominant language
C
Stars
4
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from HarryR/logpipe

All issues in HarryR/logpipe

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.