initial docs

BarnabyShearer · Nov 14, 2021 · 825dc2e · 825dc2e
1 parent 07c7042
commit 825dc2e
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,18 @@
+pynfc
+=====
+
+`ctypeslib` converted libnfc and libfreefare.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install
+   pynfc
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/install.rst b/docs/install.rst
@@ -0,0 +1,8 @@
+Installation
+============
+
+::
+
+    sudo apt install libfreefare-dev
+    pip install pynfc
+
diff --git a/docs/pynfc.rst b/docs/pynfc.rst
@@ -0,0 +1,5 @@
+pynfc
+=====
+
+.. automodule:: pynfc
+   :members: