docs: add video example to docs

sradc · Oct 8, 2023 · ca727bd · ca727bd
1 parent 9918662
commit ca727bd
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 6 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+*.mp4 filter=lfs diff=lfs merge=lfs -text
diff --git a/README.ipynb b/README.ipynb
@@ -24,7 +24,7 @@
     "`pip install make_agents`\n",
     " \n",
     "<p align=\"center\">\n",
-    "  <img src=\"README_files/make_agents_logo.jpg\" width=256>\n",
+    "  <img src=\"static/make_agents_logo.jpg\" width=256>\n",
     "</p>\n",
     "\n",
     "# MakeAgents \n",
@@ -44,6 +44,10 @@
     "\n",
     "## Examples\n",
     "\n",
+    "Here's a video showing a MakeAgents agent in action:\n",
+    "\n",
+    "![Bash assistant example](static/bash_assistant_example.mp4)\n",
+    "\n",
     "### Example 1: A conversational agent tasked with getting the user's name"
    ]
   },

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ limitations under the License. -->
 `pip install make_agents`
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/sradc/MakeAgents/main/README_files/make_agents_logo.jpg" width=256>
+  <img src="https://raw.githubusercontent.com/sradc/MakeAgents/main/static/make_agents_logo.jpg" width=256>
 </p>
 
 # MakeAgents 
@@ -38,6 +38,10 @@ Currently supports OpenAI's GPT chat models out of the box.
 
 ## Examples
 
+Here's a video showing a MakeAgents agent in action:
+
+![Bash assistant example](static/bash_assistant_example.mp4)
+
 ### Example 1: A conversational agent tasked with getting the user's name
 
 

diff --git a/scripts/replace_readme_image_links.py b/scripts/replace_readme_image_links.py
@@ -7,14 +7,16 @@
     GITHUB_PATH = "sradc/MakeAgents/main"
 
     with open(FILE_PATH, "r") as file:
-        data = file.read()
+        text = file.read()
 
     # Find links referencing README_files/ and replace them with absolute links
     pattern = r"(README_files/.*\.(png|jpg))"
     replacement = r"https://raw.githubusercontent.com/" + GITHUB_PATH + r"/\1"
+    text = re.sub(pattern, replacement, text)
 
-    # Substitute the pattern with the replacement
-    new_data = re.sub(pattern, replacement, data)
+    pattern = r"(static/.*\.(png|jpg))"
+    replacement = r"https://raw.githubusercontent.com/" + GITHUB_PATH + r"/\1"
+    text = re.sub(pattern, replacement, text)
 
     with open(FILE_PATH, "w") as file:
-        file.write(new_data)
+        file.write(text)
diff --git a/static/bash_assistant_example.mp4 b/static/bash_assistant_example.mp4
diff --git a/README_files/make_agents_logo.jpg → static/make_agents_logo.jpg b/README_files/make_agents_logo.jpg → static/make_agents_logo.jpg