Add a help target to Makefile

Open Beginner friendly
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
60/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Domain
build-system

Research direction

Open the repository's Makefile and compare its existing targets with the GNU Make Rules documentation linked in the issue. Run make, make clean, and make help in a terminal; done means the help output lists the default, clean, and help targets and the commands work as expected.

Written by the indexing model from the issue text.

Description

documentation good first issue Hacktoberfest help wanted

Utilize GNU Make documentation to create a help target

Requirements
  • Update make file with a command that lists what commands can be done
    • e.g. use @echo to list the targets and what they do
  • List all the commands/target within main
    • Default make, clean, and help

Resources to see examples of targets and Make documentation can be found here.

Make sure to test within your terminal to see that the code compiles and works correctly!

Dominant language
Makefile
Stars
1
Forks
5
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 Hunter-Open-Source-Club/hacktoberfest21.cpp

All issues in Hunter-Open-Source-Club/hacktoberfest21.cpp

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.