diff --git a/README.md b/README.md index 504a882..b3c8c5f 100644 --- a/README.md +++ b/README.md @@ -46,14 +46,9 @@ First, get the sources and change to the source directory: $ cd pyalsaaudio ``` -Then, build: +Then, build and install: ``` - $ python setup.py build -``` - -And install: -``` - $ sudo python setup.py install + $ pip install . ``` # Using the API diff --git a/doc/README.md b/doc/README.md index 8b26e3b..f06abe4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,28 +1,18 @@ # Make a new release -Update the version in setup.py +Create and push a tag naming the version (i.e. 0.11.1): - pyalsa_version = '0.9.0' + git tag 0.11.1 + git push origin 0.11.1 -Commit and push the update. - -Create and push a tag naming the version (i.e. 0.9.0): - - git tag 0.9.0 - git push origin 0.9.0 - -Create the package: - - python3 setup.py sdist - -Upload the package - - twine upload dist/* - -Don't forget to update the documentation. +This should trigger a build via a github actions and publish pre-built binaries to pypi.org # Publish the documentation +All commits to main should trigger a rebuild of the documentation. + +## Historical background + 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 diff --git a/doc/pyalsaaudio.rst b/doc/pyalsaaudio.rst index 3f033ff..cf1ee98 100644 --- a/doc/pyalsaaudio.rst +++ b/doc/pyalsaaudio.rst @@ -86,11 +86,7 @@ ship with ALSA kernels. To install, execute the following: --- :: - $ python setup.py build - -And then as root: --- :: - - # python setup.py install + $ pip install . *******