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
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (5.6%) to scientific vocabulary
Last synced: 8 months ago
·
JSON representation
·
Repository
Makefile help comments
Basic Info
- Host: GitHub
- Owner: SixArm
- Language: Makefile
- Default Branch: main
- Size: 1000 Bytes
Statistics
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Created over 1 year ago
· Last pushed about 1 year ago
Metadata Files
Readme
Citation
README.md
Makefile help comments
Makefile help comments: how you can add easy documentation to a Makefile.
Add this task to a Makefile:
makefile
.PHONY: help
help:
@awk '/^##/{a=1-a}a' $(MAKEFILE_LIST) | cut -c3-
Then add any help comments to your Makefile. A help comment starts with two hash marks, and ends with two hash marks.
```makefile
This is a help comment.
You can use as many lines as you wish.
```
Now you can run the task:
sh
make help
Makefile example
```
Makefile help comments: how you can add easy documentation to a Makefile.
A help comment starts with two hash marks, and ends with two hash marks.
This syntax purposefully makes it easy for developers to convert any
existing Makefile comments into help comments.
Compared to other kinds of well-known make self-documentation tools,
this implementation is simpler to use and also is much more flexible.
To use this:
make help
https://github.com/sixarm/makefile-help-comments
help: display this help message.
.PHONY: help help: @awk '/^##/{a=1-a}a' $(MAKEFILE_LIST) | cut -c3-
You can write help comments anywhere you want,
such as between tasks, like this help comment.
alfa: echo the word alfa.
alfa: @echo "alfa"
You can write anything you want in a help comment,
such as ASCII art, and whatever you write is displayed.
^__^
(oo)_______
(__)\ )\/\
||----w |
|| ||
bravo: echo the word bravo.
bravo: @echo "bravo"
This line is a normal comment.
This line is another normal comment.
These normal comments are not printed by the help task.
charlie: echo the word charlie.
charlie: @echo "charlie"
If you wish, you can end with a footer comment with more information.
To contact the author, email joel@joelparkerhenderson.com.
```
Owner
- Name: SixArm
- Login: SixArm
- Kind: organization
- Email: sixarm@sixarm.com
- Location: San Francisco
- Website: http://sixarm.com
- Twitter: sixarm
- Repositories: 580
- Profile: https://github.com/SixArm
SixArm Software
Citation (CITATION.cff)
cff-version: 1.2.0
title: Makefile help comments
message: >-
If you use this work and you want to cite it,
then you can use the metadata from this file.
type: software
authors:
- given-names: Joel Parker
family-names: Henderson
email: joel@joelparkerhenderson.com
affiliation: joelparkerhenderson.com
orcid: 'https://orcid.org/0009-0000-4681-282X'
identifiers:
- type: url
value: 'https://github.com/SixArm/makefile-help-comments/'
description: Makefile help comments
repository-code: 'https://github.com/SixArm/makefile-help-comments/'
abstract: >-
Makefile help comments
license: See license file
GitHub Events
Total
- Watch event: 3
- Push event: 6
- Create event: 2
Last Year
- Watch event: 3
- Push event: 6
- Create event: 2
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Joel Parker Henderson | j****l@j****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0