Copy over docs from #97

Author: denialhaag

docs/contributing.md

@@ -1,3 +1,3 @@
-# Contributing
+```{include} ../.github/contributing.md
 
-The documentation of MQT NAViz is still under construction.
+```

docs/installation.md

@@ -1,3 +1,118 @@
 # Installation
 
-The documentation of MQT NAViz is still under construction.
+MQT NAViz is mainly developed as a Rust library with Python bindings.
+The resulting Python package is available on [PyPI](https://pypi.org/project/mqt.naviz/) and can be installed on all major operating systems using all modern Python versions.
+
+:::::{tip}
+We highly recommend using [`uv`](https://docs.astral.sh/uv/) for working with Python projects.
+It is an extremely fast Python package and project manager, written in Rust and developed by [Astral](https://astral.sh/) (the same team behind [`ruff`](https://docs.astral.sh/ruff/)).
+It can act as a drop-in replacement for `pip` and `virtualenv`, and provides a more modern and faster alternative to the traditional Python package management tools.
+It automatically handles the creation of virtual environments and the installation of packages, and is much faster than `pip`.
+Additionally, it can even set up Python for you if it is not installed yet.
+
+If you do not have `uv` installed yet, you can install it via:
+
+::::{tab-set}
+
+:::{tab-item} macOS and Linux
+
+```console
+$ curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+:::
+
+:::{tab-item} Windows
+
+```console
+$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+:::
+
+::::
+
+Check out their excellent [documentation](https://docs.astral.sh/uv/) for more information.
+
+:::::
+
+::::{tab-set}
+:sync-group: installer
+
+:::{tab-item} uv _(recommended)_
+:sync: uv
+
+```console
+$ uv pip install mqt.naviz
+```
+
+:::
+
+:::{tab-item} pip
+:sync: pip
+
+```console
+(.venv) $ python -m pip install mqt.naviz
+```
+
+:::
+
+::::
+
+In most practical cases (under 64-bit Linux, MacOS incl. Apple Silicon, and Windows), this requires no compilation and merely downloads and installs a platform-specific pre-built wheel.
+
+Once installed, you can check if the installation was successful by running:
+
+<!-- todo: adapt the following code -->
+
+```console
+(.venv) $ python -c "import mqt.naviz; print(mqt.naviz.__version__)"
+```
+
+which should print the installed version of the library.
+
+## Building from source for performance
+
+For building MQT NAViz from the source, take a look at the {doc}`Development Guide <development_guide>`.
+
+## Integrating MQT NAViz into your project
+
+If you want to use the MQT Naviz Python package in your own project, you can simply add it as a dependency in your `pyproject.toml` or `setup.py` file.
+This will automatically install the MQT Naviz package when your project is installed.
+
+::::{tab-set}
+
+:::{tab-item} uv _(recommended)_
+
+```console
+$ uv add mqt.naviz
+```
+
+:::
+
+:::{tab-item} pyproject.toml
+
+```toml
+[project]
+# ...
+dependencies = ["mqt.naviz>=0.1.1"]
+# ...
+```
+
+:::
+
+:::{tab-item} setup.py
+
+```python
+from setuptools import setup
+
+setup(
+    # ...
+    install_requires=["mqt.naviz>=0.1.1"],
+    # ...
+)
+```
+
+:::
+
+::::

docs/support.md

@@ -1,3 +1,3 @@
-# Support
+```{include} ../.github/support.md
 
-The documentation of MQT NAViz is still under construction.
+```

docs/usage.md

@@ -1,3 +1,44 @@
 # Usage
 
-The documentation of MQT NAViz is still under construction.
+## Standalone Application
+
+NAViz allows opening `.naviz` instruction files or importing instructions from external formats such as `mqt na` under the `File` menu.
+Alternatively, files can simply be dropped onto or pasted into the application.
+You can read more about the supported file formats in the {doc}`file format documentation <file_format>`.
+
+The machine and style can be selected from the `Machine` and `Style` menus respectively.
+These menus allow selecting a config from the loaded configs as well as opening or importing a new config.
+
+When the animation plays, the progress bar at the bottom of the window can be used to seek through the visualization.
+
+## Python Package
+
+The python library currently only exports a simple functionality to export a visualization as a video.
+An example can be seen below:
+
+```python
+from naviz import *
+
+# Get machine and style from repository
+machine = Repository.machines().get("example")
+style = Repository.machines().get("tum")
+
+# Alternatively, you can also use manual configurations
+machine = "<...>"
+style = "<...>"
+
+# Render `naviz` instructions to `out.mp4` at 1080p60
+export_video("<naviz instructions>", "out.mp4", (1920, 1080), 60, machine, style)
+
+# Render `mqt na` instructions to `out.mp4` at 1080p60 with the default import options
+# Alternatively, substitute the call to `default_import_settings` with your custom import settings
+export_video(
+    "<mqt na instructions>",
+    "out.mp4",
+    (1920, 1080),
+    60,
+    machine,
+    style,
+    default_import_settings("MqtNa"),
+)
+```