diff --git a/README.md b/README.md index ec187a1..b5d2571 100644 --- a/README.md +++ b/README.md @@ -81,24 +81,24 @@ Here are animated demonstrations of the EbookReader's key features: Page Navigation
- Page Navigation
+ Page Navigation
Forward and backward navigation through pages Font Size Adjustment
- Font Size
+ Font Size
Dynamic font size scaling with position preservation Chapter Navigation
- Chapter Navigation
+ Chapter Navigation
Jump directly to chapters by title or index Bookmarks & Positions
- Bookmarks
+ Bookmarks
Save and restore reading positions anywhere in the book diff --git a/examples/gifs/README.md b/docs/images/README.md similarity index 93% rename from examples/gifs/README.md rename to docs/images/README.md index 5a5d500..1eaa4c6 100644 --- a/examples/gifs/README.md +++ b/docs/images/README.md @@ -45,7 +45,7 @@ To generate these animations with your own EPUB file: ```bash cd examples -python generate_ereader_gifs.py path/to/your/book.epub gifs/ +python generate_ereader_gifs.py path/to/your/book.epub ../docs/images/ ``` This will create all four GIF animations in the specified output directory. @@ -91,10 +91,10 @@ These GIFs are embedded in the main [README.md](../../README.md) to showcase the To embed in Markdown: ```markdown -![Page Navigation](examples/gifs/ereader_page_navigation.gif) +![Page Navigation](docs/images/ereader_page_navigation.gif) ``` To embed in HTML with size control: ```html -Page Navigation +Page Navigation ``` diff --git a/examples/generate_ereader_gifs.py b/examples/generate_ereader_gifs.py index 94383dc..cf43a19 100644 --- a/examples/generate_ereader_gifs.py +++ b/examples/generate_ereader_gifs.py @@ -12,6 +12,9 @@ The GIFs are saved to the examples/ directory and can be included in documentati Usage: python generate_ereader_gifs.py path/to/book.epub [output_dir] + +Example: + python generate_ereader_gifs.py ../tests/data/test.epub ../docs/images """ import sys @@ -211,7 +214,7 @@ def main(): if len(sys.argv) < 2: print("Usage: python generate_ereader_gifs.py path/to/book.epub [output_dir]") print("\nExample:") - print(" python generate_ereader_gifs.py ../tests/data/test.epub ./gifs") + print(" python generate_ereader_gifs.py ../tests/data/test.epub ../docs/images") sys.exit(1) epub_path = sys.argv[1]