Upload README.md

README.md

@@ -1,3 +1,36 @@
----
-license: mit
----
+# Table of Contents
+
+* [InteractiveCodeGenFlow](#InteractiveCodeGenFlow)
+  * [InteractiveCodeGenFlow](#InteractiveCodeGenFlow.InteractiveCodeGenFlow)
+* [\_\_init\_\_](#__init__)
+
+<a id="InteractiveCodeGenFlow"></a>
+
+# InteractiveCodeGenFlow
+
+<a id="InteractiveCodeGenFlow.InteractiveCodeGenFlow"></a>
+
+## InteractiveCodeGenFlow Objects
+
+```python
+class InteractiveCodeGenFlow(SequentialFlow)
+```
+
+This flow writes code in an interactive manner. It is a sequential flow composed of:
+1. MemoryReading: reads in the code library.
+2. CodeGenerator: generates code based on the goal and functions in the code library.
+3. CodeFileEditor: writes the generated code to a temp file for the user to see, edit and provide feedback.
+4. ParseFeedback: opens up the temp file with vscode and parses the feedback from the user.
+
+*Input Interface*:
+- `goal`
+
+*Output Interface*:
+- `code`
+- `feedback`
+- `temp_code_file_location`
+
+<a id="__init__"></a>
+
+# \_\_init\_\_
+