Browse Source

Update contribute link in README.md

master
Jason T. Lenz 1 year ago
parent
commit
e734bbd143
  1. 23
      Makefile
  2. 9
      README.md
  3. 18
      template/README.md
  4. 6
      template/README.md.got

23
Makefile

@ -112,32 +112,21 @@ cleanCheck:
#---Generate Main Documents---
DOCMAIN := README.md LICENSE
regenDocMain:
pgot -i ":$(RTEMPLATE)" -o README.md template/README.md.got
pgot -i ":$(RTEMPLATE)" -o LICENSE $(RTEMPLATE)/LICENSE.src/BSD-2-clause.got
README.md: template/README.md.got
pgot -i ":$(RTEMPLATE)" -o $@ $<
LICENSE: $(RTEMPLATE)/LICENSE.src/BSD-2-clause.got
pgot -i ":$(RTEMPLATE)" -o $@ $<
docMain: $(DOCMAIN)
cleanDocMain:
$(RM) $(DOCMAIN)
.PHONY: docMain, cleanDocMain
.PHONY: regenDocMain
#---Generate Makefile---
Makefile: template/Makefile.got
pgot -i ":$(RTEMPLATE)" -o $@ $<
mkFile: Makefile
regenMkFile:
regenMakefile:
pgot -i ":$(RTEMPLATE)" -o Makefile template/Makefile.got
.PHONY: mkFile regenMkFile
.PHONY: regenMakefile
#---Lint Helper Target---

9
README.md

@ -244,21 +244,18 @@ $ make check
If you have a bugfix, update, issue or feature enhancement the best way to reach
me is by following the instructions in the link below. Thank you!
<https://blog.lenzplace.org/about/contact.html>
<https://blog.lenzplace.org/contact>
## Versioning
I follow the [SemVer](http://semver.org/) strategy for versioning. The latest
version is listed in the [releases](/lenzj/pgot/releases) section.
## License
This project is licensed under a BSD two clause license - see the
[LICENSE](LICENSE) file for details.
## FAQ
**Q**: What causes the following error message: "pgot : invalid character '}'
@ -290,6 +287,4 @@ in the global pipeline defined at time of template execution.
## Other similar projects
* <https://github.com/hairyhenderson/gomplate>
* <https://github.com/gliderlabs/sigil>
<!-- vim:set ts=4 sw=4 et tw=80: -->
* <https://github.com/gliderlabs/sigil>

18
template/README.md

@ -0,0 +1,18 @@
# Purpose
This "template" folder contains templates and associates scripts to generate
standard repository files such as README.md and LICENSE. This is primarily
used by the author to ensure consistency across repositories and can safely be
ignored by most end users and contributors.
# Usage
If you do desire to use or process templates in this folder make sure you have
cloned the git repository at <https://git.lenzplace.org/lenzj/repo-template>.
The cloned "repo-template" respository should ideally exist one level outside
this repository root. I.E. ../repo-template
Once this is in place you can regenerate the documents from templates using the
following command from the main repository folder:
$ make regenDocMain

6
template/README.md.got

@ -246,11 +246,8 @@ $ make check
```
{{template "rd-contributing" .}}
{{template "rd-versioning" .}}
{{template "rd-license" .}}
## FAQ
**Q**: What causes the following error message: "pgot : invalid character '}'
@ -283,5 +280,4 @@ in the global pipeline defined at time of template execution.
* <https://github.com/hairyhenderson/gomplate>
* <https://github.com/gliderlabs/sigil>
<!-- vim:set ts=4 sw=4 et tw=80: -->
{{- /* vim:set ts=4 sw=4 et tw=80: */ -}}
Loading…
Cancel
Save