From c86e3f027a100e2bc0959a41d3aa218d057d5fe6 Mon Sep 17 00:00:00 2001 From: nirenjan Date: Tue, 26 May 2020 16:16:54 -0700 Subject: [PATCH] Add install rule for Doxygen generated docs --- ChangeLog.md | 1 + Makefile.am | 3 +++ README.md | 6 ++++++ 3 files changed, 10 insertions(+) diff --git a/ChangeLog.md b/ChangeLog.md index c50c701..ae94d8f 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -12,6 +12,7 @@ The format is based upon [Keep a Changelog]. - Internationalization for the following: * libx52 * x52test +- Doxygen generation of HTML documentation for libx52 methods. ### Changed - libx52_init no longer fails when a supported joystick is not connected. diff --git a/Makefile.am b/Makefile.am index 939ed3f..2e0646f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -38,4 +38,7 @@ CLEANFILES = docs all-local: docs/.stamp clean-local: rm -rf $(top_builddir)/docs +install-data-local: + $(INSTALL) -d $(DESTDIR)$(docdir) + rsync -a $(top_builddir)/docs/html $(DESTDIR)$(docdir) endif diff --git a/README.md b/README.md index 8590147..a6a0ff9 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,12 @@ You will need the following packages: If you are on OSX, you can install the above packages using Homebrew +If you want to generate HTML documentation for the library, you will need the +following packages: + +* doxygen +* rsync + ## Installation 1. Clone the repository