Merge pull request #2 from bcrawford39GT/update_readme

added readme text.

Author: bcrawford39GT

README.md

@@ -1 +1,26 @@
-# github_tutorial
+##  github_tutorial 
+
+### Overview
+
+This is a basic github repository to show a Github structure, docstrings, and test codes via pytest.
+
+### Documentation
+
+### To be added in the future.
+
+### Installation
+
+The  github_tutorial package dependencies can be installed via conda, and this package tagged in conda via pip install:
+
+Create and install conda package:
+`cd path_to_first_github_tutorial_dirctory_with_environment_yml_file`'
+
+`conda env create -f environment.yml`
+
+`conda activate github_tutorial`
+
+`pip install -e .`
+
+Note: If you update the conda package, you may have to redo the pip install.  Without doing this, it may allow incompatable versions of the dependencies to be installed, etc.:
+
+`pip install -e .`