fix #345 compile readme

README.md

@@ -70,6 +70,9 @@ Note: This requires Graphviz to be installed on your system.
 
 Here's how to quickly start using `typed-ffmpeg`:
 
+
+
+
 ```python
 import ffmpeg
 
@@ -80,37 +83,56 @@ f = (
     .hflip()
     .output(filename='output.mp4')
 )
-f.run()
+f
 ```
 
-![](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/quick-usage.png)
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_1_0.svg)
+
+
+
 
 For a more complex example:
 
+
+
 ```python
+import ffmpeg.filters
 import ffmpeg
 
 # Complex filter graph example
 in_file = ffmpeg.input("input.mp4")
 overlay_file = ffmpeg.input("overlay.png")
 
 f = (
-    ffmpeg
+    ffmpeg.filters
     .concat(
         in_file.trim(start_frame=10, end_frame=20),
         in_file.trim(start_frame=30, end_frame=40),
     )
+    .video(0)
     .overlay(overlay_file.hflip())
     .drawbox(x="50", y="50", width="120", height="120", color="red", thickness="5")
     .output(filename="out.mp4")
 )
-f.run()
+f
 ```
 
-![](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/quick-usage-complex.png)
+
+
+
+
+![svg](https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/docs/media/README_files/README_3_0.svg)
+
+
+
 
 See the [Usage](https://livingbio.github.io/typed-ffmpeg/usage/typed/) section in our documentation for more examples and detailed guides.
 
+
 ---
 
 ## Acknowledgements

scripts/compile-readme.py

@@ -0,0 +1,43 @@
+import os
+import shutil
+
+import typer
+
+
+def post_process(markdown_file: str, original_folder: str, new_folder: str) -> None:
+    rel_path = "https://raw.githubusercontent.com/livingbio/typed-ffmpeg/main/" + new_folder
+
+    # Move the folder
+    if os.path.exists(original_folder):
+        for filepath in os.listdir(original_folder):
+            # Move the file, replace if it already exists
+            old_path = os.path.join(original_folder, filepath)
+            new_path = os.path.join(new_folder, filepath)
+            if os.path.exists(new_path):
+                os.remove(new_path)
+
+            shutil.move(old_path, new_path)
+            print(f"Moved {filepath} to {new_folder}")
+
+    # Update paths in the Markdown file
+    with open(markdown_file, "r") as file:
+        content = file.read()
+
+    content = content.replace(original_folder, rel_path)
+
+    with open(markdown_file, "w") as file:
+        file.write(content)
+
+    print("Image paths updated and folder moved.")
+
+
+def main() -> None:
+    os.remove("README.md")
+    os.system("jupyter nbconvert --to markdown README.ipynb")
+    assert os.path.exists("README.md")
+
+    post_process("README.md", "README_files", "docs/media/README_files")
+
+
+if __name__ == "__main__":
+    typer.run(main)