From 85fdea19c2746cd414ef2126322df4b591247d52 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Thu, 17 Mar 2016 13:40:24 +1000 Subject: [PATCH] Link to the github-pages generated documentation To update the documentation, do the following: # delete current documentation pushd doc/html rm -rf $PWD/* # clone into current directory, checkout gh-pages git clone git@github.com:libratbag/libratbag . git checkout -b gh-pages # delete master branch so we don't accidentally push that one git branch -d master # return to main, generate docs popd make # commit updated docs, push pushd doc/html git commit -asm "Updated documentation" git push origin gh-pages popd Signed-off-by: Peter Hutterer --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2e3af702..bd7328bf 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,13 @@ libratbag is a configuration library for gaming mice. It provides a generic way to access the various features exposed by these mice and abstracts away hardware-specific and kernel-specific quirks. +Documentation +------------- + +API documentation is available here: + + http://libratbag.github.io/libratbag/ + Architecture ------------