diff --git a/README.md b/README.md index d155b98..e9fd0e0 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,17 @@ python project template for me. -Please refer to: [https://notes.kinoshita-lab.org/20240329134609-python%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E4%BD%9C%E3%82%8A%E6%96%B9](https://notes.kinoshita-lab.org/20240329134609-python%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E4%BD%9C%E3%82%8A%E6%96%B9) \ No newline at end of file +## Prerequisites: +- pyenv installed +- poetry 1.8 or newer installed with the specific pyenv environment you want to use + + +## Usage: +- clone this repository +- `poetry install [library you want to use]` +- `poetry run python [python-project-template]` +- Also contains vscode configuration + + + +Please refer to the note below for details [pythonプロジェクトの実行方法 作り方](https://notes.kinoshita-lab.org/20240329134609-python%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E4%BD%9C%E3%82%8A%E6%96%B9) \ No newline at end of file