From 3f440d9acfeb42ed8d70b363a8bab1d3edaccad3 Mon Sep 17 00:00:00 2001
From: cs-hall <67027056+cs-hall@users.noreply.github.com>
Date: Tue, 21 May 2024 12:12:52 -0400
Subject: [PATCH] Update README to include instructions

Instructions came from the 3rd lecture in ComPsy class
---
 README.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.rst b/README.rst
index 8a7fb9b..aefde7f 100644
--- a/README.rst
+++ b/README.rst
@@ -13,6 +13,48 @@ it should make you happy.
 
 Prepare to SMILE...
 
+Installing SMILE
+================
+
+First you need Kivy, which is the primary dependency of SMILE
+Sometimes kivy has conflicts with some other packages, so we create a new virtual environment for working with SMILE:
+
+::
+
+    conda create -n smile    
+    conda activate smile
+
+Now we can install kivy:
+
+::
+
+    conda install -c conda-forge kivy
+
+
+If you plan on running SMILE from within Jupyter Notebook (only suggested for development and not data collection), you'll need to install that, too:
+
+::
+    
+    conda install notebook
+
+
+Then you can install SMILE right from the GitHub repository:
+
+::
+    
+    pip install --upgrade git+https://github.com/compmem/smile
+
+
+All together...
+
+::
+
+    conda create -n smile    
+    conda activate smile
+    conda install -c conda-forge kivy
+    pip install --upgrade git+https://github.com/compmem/smile
+
+
 
 Dependencies
 ============
@@ -44,3 +86,4 @@ Documentation
 =============
 
 For detailed documentation, please visit http://smile-docs.readthedocs.io/
+