Merge pull request #1 from kotaro-kinoshita/doc/desc-readme

desc readme

README.md

@@ -0,0 +1,27 @@
+# YomiToku-dev
+YomiTokuの開発用リポジトリ
+
+# Setup
+## リポジトリからのインストール
+- 仮想環境のセットアップ
+```
+uv sync --dev
+```
+
+## TestPyPIからのインストール
+```
+pip install --index-url https://test.pypi.org/simple/ yomitoku
+```
+
+
+- 重みファイルのダウンロードし、実行フォルダに配置
+https://drive.google.com/drive/folders/1xMClVygBcK8pJnxKn8Cd7vIJoTBw4Nut?usp=sharing
+
+
+# Demo
+```
+uv run python examples/simple_ocr.py  --vis --image ${PATH_IMAGE} --config ${PATH_CONFIG}
+```
+- デフォルトのconfigファイルは`configs/ocr.yaml`にあります
+- config内の重みファイルのパス`WEIGHTS`を任意のパスに書き換える
+- --visオプションは出力先に予測結果の可視化画像を出力する

examples/simple_ocr.py

@@ -32,7 +32,7 @@ def main(args):
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument("--config", type=str, default="configs/ocr.yaml")
-    parser.add_argument("--image", type=str, default="dataset/00000528_0894389_62.jpg")
+    parser.add_argument("--image", type=str, default="dataset/00003126_5721251_5.jpg")
     parser.add_argument("--vis", action="store_true")
     parser.add_argument("--outdir", type=str, default="results")
     args = parser.parse_args()