auracaster/sw_pyalsaaudio
3
0
Fork 0
forked from auracaster/pyalsaaudio
Code Pull Requests Activity

Improve Readme

Browse Source
This commit is contained in:
Lars Immisch
2015-05-11 22:18:19 +02:00
parent 526bd05eaf
commit 2112840b4d
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/README.md
View File

@@ -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.