Header3 is a package for Emacs which will help you to automatically add headers to your source code files when you create a new one in Emacs.
Header3 is built upon header2.el and adds more features to it.
if you need the smallest header.
if you need a little bigger headers.
if you need the biggest one.
The following example is auto generated when you create a new Readme.md file (file name is case insensitive)
The following example is generated when you run make-readme-header and the file
already has some contents
All examples are generated using Header3.
- All Features of header2.el plus
- Standard header format.
- Auto timestamp for file creation and file updating.
- Automatic entry of the user name of last update and keeping track of update number.
- Easy Customisation Interface available. Send bug reports within the interface.
- Keep Commentary and Change Log inside the file.
- Automatically add git project link into the header
- Automatically add License to the files.
- Automatically add Readme template with random footer badges from For the Badge
-
Download tar file from the Releases.
-
Then use
package-install-fileinside emacs and point it to the tar package.
-
Git-link This package is used to extract the git link of the current buffer.
-
Projectile This package is the one which will check your project directory and get its root path. Projectile provides us with project name and project path which is used to check if the project root contains any License file. If it does then it checks the first 5 lines for any mention of "License" and "Version" (case-insensitive).
Instructions to install these packages are available at their links.
- All new files created inside Emacs will automatically trigger a function that will add the header.
- If you need to add header to an existing file execute using
M-xandmake-mini-headermake-file-headermake-package-headermake-readme-header
For full documentation read the docs
Visit website.
Read CHANGELOG, CONTRIBUTING guide.
Licensed under the terms of GPL v3
