From 2112840b4dc2c5e12437b21d5d44a17c1cc527e1 Mon Sep 17 00:00:00 2001 From: Lars Immisch Date: Mon, 11 May 2015 22:18:19 +0200 Subject: [PATCH] Improve Readme --- doc/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 3a611b7..d38b695 100644 --- a/doc/README.md +++ b/doc/README.md @@ -3,12 +3,15 @@ The documentation is published through the `gh-pages` branch. To publish the documentation, you need to clone the `gh-pages` branch of this repository into -`docs/gh-pages`. In `docs`, do: +`doc/gh-pages`. In `doc`, do: git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages -Once that is setup, you can publish new documentation using: +(This is a bit of a hack) + +Once that is set up, you can publish new documentation using: make publish -Be careful when new files are generated, however, you will have to add them manually. +Be careful when new files are generated, however, you will have to add them +manually to git.