From 154dbaffaa0a4ed9fced4b3f3fd785aa60d57246 Mon Sep 17 00:00:00 2001
From: Marcin Kostrzewski <komar86311@gmail.com>
Date: Thu, 14 May 2020 15:00:31 +0200
Subject: [PATCH] Added readme

---
 doc/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 doc/README.md

diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..e85cc51
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,23 @@
+# Sphinx autodoc
+
+Pliki źródłowe do generowania automatycznej dokumentacji kodu za pomocą biblioteki Sphinx.
+
+## Wymagania:
+```
+Python 3.x
+sphinx: 4.x
+```
+
+## Ręczne budowanie dokumentacji
+Windows: 
+```shell script
+make.bat html
+```
+Linux/MacOS:
+```shell script
+make html
+```
+
+## Automatyczne budowanie dokumentacji w PyCharm
+W PyCharmie tworzymy nową konfigurację Python docs -> Sphinx. Jako parametr "input" uswiatiamy ścieżkę do tego folderu,
+a output wskazujemy tam, gdzie chcemy otrzymać gotową dokumentację.
\ No newline at end of file