Git-Workshop.md

@@ -2446,7 +2446,53 @@ MANIFEST
 
 #### README.md
 
-TBW
+A Readme file is a developer getting started guide. It tells anyone cloning your
+repo:
+
+  - What to install
+  - How to install everything
+  - How to compile (if necessary)
+  - How to run the program
+  - What to expect in typical input
+  - What to expect in typical output
+
+We will create a [multimarkdown](https://michaelhyatt.com/multimarkdown/) style
+`README.md`. We will base our document on [what I require of my CS 417/517
+students](https://www.cs.odu.edu/~tkennedy/cs417/s20/Public/exampleReadme/index.html#python-example).
+
+
+  1. Create a new file `README.md` in your repo.
+  2. Copy-and-Paste the folling content into the file.
+
+
+  ````markdown
+  # Requirements
+
+    * Python 3.7
+
+  > This code makes use of the `f"..."` or [f-string
+  > syntax](https://www.python.org/dev/peps/pep-0498/). This syntax was
+  > introduced in Python 3.6.
+
+
+  # Sample Execution & Output
+
+  If run without command line arguments, using
+
+  ```
+  python newtons_method.py
+  ```
+
+  the following usage message will be displayed.
+
+  ```
+  Usage: ./newtons_method.py initial_guess
+  ```
+  ````
+
+
+
+
 
 ---