diff options
| author |  Mike Burns <mike@mike-burns.com> | 2013-07-31 18:16:01 -0400 |
|---|---|---|
| committer | Mike Burns <mike@mike-burns.com> | 2013-08-01 15:05:19 -0400 |
| commit | aacff1b269a39c967f84ab33b68f827febee8891 (patch) | |
| tree | 3965aecfe4602e48264df778e5037aa8090cb674 /DEVELOPERS.md | |
| parent | bc1364d1a195572bf470c81352c01bc8dfec6880 (diff) | |
Add a release target
The `make release` command will build the Debian package, push the
version to a git tag on GitHub, and upload the docs to GitHub pages.
This also adds a `deb` target, along with `build-docs`, `upload-docs`,
`build-tag`, and `push-tag`.
In addition, introduce a `NEWS.md` file.
Both `rcm.sh.in` and `NEWS.md.in` will act as input files. This is to
abstract over the version number.
Diffstat (limited to 'DEVELOPERS.md')
| -rw-r--r-- | DEVELOPERS.md | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 973a66a..4d2b684 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -6,11 +6,9 @@ GNU autoconf & automake This project uses GNU autoconf and automake for installation and building. To regenerate everything from first principles (`configure.ac` -and `**/Makefile.am`), run these commands: +and `**/Makefile.am`), run the command: - aclocal && \ - automake --add-missing --copy && \ - autoconf + ./autogen.sh Debian ------ @@ -33,13 +31,10 @@ Debian packaging tools, especially debuild: HTML documentation ------------------ -The HTML documentation can be generated using the mdocml suite, -especially mandoc(1). This shell command will generate them all into a -separate `rcm-gh-pages` directory: +The HTML documentation is generated using the mdocml suite. Use the +`upload-docs` make target to rebuild the HTML docs and upload them to +GitHub Pages. The `build-docs` target will just build them. - for i in lsrc.1 mkrc.1 rcm.7 rcrc.5 rcup.1; do - mandoc -Thtml -Oman=%N.%S.html man/$i > ~/rcm-gh-pages/$i.html - done - cp ~/rcm-gh-pages/rcm.7.html ~/rcm-gh-pages/index.html + make upload-docs More information on mdocml can be found on http://mdocml.bsd.lv/ . |