Data

Tools

Indexes

Applications

Experiments

Open Source Science

makefile-support-for-help

Supporting 'help' as a target within Makefiles for self-documentation

https://github.com/the-aeydr/makefile-support-for-help

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.2%) to scientific vocabulary

Keywords

makefile
Last synced: 6 months ago · JSON representation ·

Repository

Supporting 'help' as a target within Makefiles for self-documentation

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
makefile
Created 9 months ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security Notice

README.md

A re-usable help command for Makefiles

Supporting 'help' as a target within Makefiles for self-documentation

This is a companion repository for the written article: A re-usable help command for Makefiles.

This repository provides supporting examples, scripts, and sample code to help illustrate the concepts and ideas discussed in the article. It is intended as a reference or demonstration only and not as a standalone library, framework, or reusable package. The contents of this repository are tightly scoped to the article's subject matter. Each resource is designed to show a specific point or concept in a simple and direct way.

For an overview of working with the contents of the repository, refer to the overview that will explain working with the repository resources, or the article, A re-usable help command for Makefiles.

You are welcome to experiment with the resources in this repository for your own study or experimentation. However, please note that:

  • There is no support or ongoing maintenance.
  • Code may be minimal and focus solely on clarity, not completeness or robustness.
  • Dependencies, if any, are listed in the article or in the script headers.

Advisory

All content in this repository is All Rights Reserved. You are welcome to read and study the contents for personal understanding or educational purposes, but be aware that this repository should be considered equivalent to written blog content: available for reading, but not licensed for derivative use.

Owner

  • Name: aeydr
  • Login: the-aeydr
  • Kind: organization

Designs, notes, writings and thoughts around building with software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you refer to this article, please cite it as below."

version: 1.0.0
date-released: 2023-07-26
title: "A re-usable help command for Makefiles"
url: "https://writing.aeydr.dev/notes/makefile-support-for-help"
authors:
- given-names: "aeydr"

preferred-citation:
  type: article
  journal: "The Architectural Decision Record"
  authors:
  - given-names: "aeydr"

  title: "A re-usable help command for Makefiles"
  month: 07
  year: 2023

GitHub Events

Total
  • Push event: 40
  • Public event: 1
  • Create event: 2
Last Year
  • Push event: 40
  • Public event: 1
  • Create event: 2

Dependencies

.devcontainer/Dockerfile docker
  • mcr.microsoft.com/devcontainers/base bullseye build
.gitpod/Dockerfile docker
  • gitpod/workspace-full latest build
LICENSE.spdx rubygems