Add Sphinx documentation

[python-musicpdaio.git] / doc / source / tutorial.rst

diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
new file mode 100644 (file)
index 0000000..31cbde9
--- /dev/null
+++ b/doc/source/tutorial.rst
@@ -0,0 +1,36 @@
+.. _tutorial:
+
+Tutorials
+=========
+
+Install
+-------
+
+For now the code is in early development stage. No releases are made.
+
+.. code:: bash
+
+   # Use a virtualenv
+   python -m venv .../path/to/my/venv
+   . .../path/to/my/venv/bin/activate
+   pip install git+https://codeberg.org/MusicPlayerDaemon/python-musicpdaio.git@main
+
+
+.. todo::
+
+   Updating a previous installation via `pip install git+https`.
+
+Getting started
+----------------
+
+
+.. literalinclude:: tutorial/tutorial-00.py
+
+
+Concurrency
+-----------
+
+.. literalinclude:: tutorial/tutorial-01.py
+
+
+.. vim: spell spelllang=en