{"id":17348256,"url":"https://github.com/diogocavilha/make-help-generator","last_synced_at":"2026-05-05T21:38:25.151Z","repository":{"id":107433841,"uuid":"159835876","full_name":"diogocavilha/make-help-generator","owner":"diogocavilha","description":"A simple Makefile help generator to use on your projects that have a Makefile.","archived":false,"fork":false,"pushed_at":"2020-09-09T18:29:30.000Z","size":5,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T16:12:41.028Z","etag":null,"topics":["bash","linux","linux-terminal","make","makefile"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/diogocavilha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-30T14:36:56.000Z","updated_at":"2023-02-09T06:32:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"a3ded892-e703-41f9-8b51-5110b1f3c583","html_url":"https://github.com/diogocavilha/make-help-generator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diogocavilha%2Fmake-help-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diogocavilha%2Fmake-help-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diogocavilha%2Fmake-help-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/diogocavilha%2Fmake-help-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/diogocavilha","download_url":"https://codeload.github.com/diogocavilha/make-help-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245840292,"owners_count":20681131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","linux","linux-terminal","make","makefile"],"created_at":"2024-10-15T16:51:45.278Z","updated_at":"2026-05-05T21:38:20.122Z","avatar_url":"https://github.com/diogocavilha.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Makefile Helper Generator :dog:\n\nIf you are working on a project which has a Makefile containing lots of commands, this might turn your life easier.\n\n## How to use it?\n\nYou must to create a file called `MakefileHelp.sh` containing the same conntent as the MakefileHelp.sh in this project. After that, you must set this file execution permission (`chmod +x MakefileHelp.sh`).\n\nThe following command will do both:\n\n```bash\nwget https://raw.githubusercontent.com/diogocavilha/make-help-generator/master/MakefileHelp.sh \\\n-q -O MakefileHelp.sh \\\n\u0026\u0026 chmod +x MakefileHelp.sh\n```\n\n## How does it work?\n\n- Your Makefile must have some comments in order to generate a properly help message. Like the Makefile example you can find in this project.\n- You must have a command called `help`, that will execute the help generator for the Makefile.\n\n**Example:**\n\nAdd help comments to your Makefile commands like:\n\n```bash\nrun:\n\t@# run - Run the project.\n\t# commands...\n\nbuild:\n\t@# build - Build the project.\n\t# commands...\n\nunit-tests:\n\t@# unit-tests - Run unit tests.\n\t# commands...\n\nintegration-tests:\n\t@# integration-tests - Run integration tests.\n\t# commands...\n\nhelp:\n\t@# help - Show this help.\n\t@./MakefileHelp.sh\n```\n\nTake a look at the last command called `help`. \nThe `help` command will print the Makefile help.\n\n```bash\nhelp:\n    @# help - Show this help.\n    @./MakefileHelp.sh\n```\nMake sure that you have the `MakefileHelp.sh` file in the right path.\n\nAfter that, you must only type `make help` and voilà! The magic happens!\n\nThe above example must print that help:\n```bash\n$ make help\n\n run                - Run the project.\n build              - Build the project.\n unit-tests         - Run unit tests.\n integration-tests  - Run integration tests.\n help               - Show this help.\n```\nNow you don't need to read all the Makefile in order to find how exaclty you must type that command you're looking for!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiogocavilha%2Fmake-help-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiogocavilha%2Fmake-help-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiogocavilha%2Fmake-help-generator/lists"}