Reworked documentation and formalize test suite

conftest.py

@@ -0,0 +1,10 @@
+import pytest
+import os
+
+
+@pytest.fixture(autouse=True)
+def skip_if_windows():
+    if os.name == "nt":
+        pytest.exit("Test suite not supported on Windows. Please use WSL.")
+    else:
+        yield

docs/.gitignore

@@ -0,0 +1 @@
+_build

docs/developers.rst

@@ -0,0 +1,15 @@
+Development
+-----------
+
+``dashing`` welcomes all contributions.
+
+Testing
+=======
+
+We use ``pytest`` for the test suite, ``pyte`` to emulate a terminal, and ``pexpect`` to spawn a process and communicate
+with the emulated terminal per test. ``pexpect`` does not fully support Windows, so the test suite can only run on WSL
+for Windows users.
+
+You can run the testsuite simply by running::
+
+   pytest

docs/index.rst

@@ -1,11 +1,23 @@
 dashing
 -------
 
+.. toctree::
+   :maxdepth: 2
+
+   developers
+
 * :ref:`genindex`
 * :ref:`modindex`
 
+Installation
+============
+
+You can install the package with::
+
+   pip install dashing
+
 Overview
 ========
 
 .. automodule:: dashing
-   :members:
+   :members:

pyproject.toml

@@ -24,7 +24,13 @@ dev = [
     "pre-commit~=3.0",
     "isort~=5.12",
     "flake8-pyproject~=1.2",
-    "bump-my-version~=0.18"
+    "bump-my-version~=0.18",
+    "dashing[test]"
+]
+test = [
+    "pytest~=8.0",
+    "pyte~=0.8",
+    "pexpect~=4.9"
 ]
 
 [tool.isort]