From 2adfc58e272ea155a2457b218faa4805ebe35e22 Mon Sep 17 00:00:00 2001
From: voetberg <magpie127@gmail.com>
Date: Mon, 25 Sep 2023 14:34:04 -0500
Subject: [PATCH] Updated docs with image on the start page, build instructions
 in readme

---
 .gitignore     |  1 +
 README.md      | 12 ++++++++++++
 docs/index.rst |  6 ++++++
 3 files changed, 19 insertions(+)

diff --git a/.gitignore b/.gitignore
index def6f50..daa7315 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+_build/
 develop-eggs/
 dist/
 downloads/
diff --git a/README.md b/README.md
index 2fb7db6..f202660 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,18 @@ Simulation library for very simple simulations to *benchmark* machine learning a
 2. A very simple data set will have objects, patterns, and signals that are intuitively quanitifiable and will be fast to generate.
 3. A very simple data set will be a great testing ground for new networks and for newcomers to practice with the technology.
 
+## Documentation
+
+#### Readthedocs link coming soon!!
+
+#### To build
+```
+pip install sphinx
+cd docs
+make html
+```
+
+The folder `docs/_build/html` will be populated with the documentation. Navigate to `file:///<Path To DeepBench>/docs/_build/html/index.html` in any web browser to view.
 
 ## Requirements
 * python = ">=3.8,<3.11,"
diff --git a/docs/index.rst b/docs/index.rst
index 8067070..b5c11cf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,6 +4,9 @@
    contain the root `toctree` directive.
 
 Welcome to DeepBench's documentation!
+
+.. image:: repository_support/DeepSkies_Logos_DeepBench.png
+   :width: 800
 =====================================
 
 .. toctree::
@@ -17,6 +20,9 @@ Welcome to DeepBench's documentation!
    shapes
    example
 
+.. image:: repository_support/DeepBench.png
+   :width: 800
+
 Indices and tables
 ==================