diff --git a/README.md b/README.md index 601e7fc..80b6e75 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,28 @@ ${REPO_DESCRIPTION} ## Requirements -Required Python version is specified in `.python-version`. +Required Python version is specified in `.py-version` (currently Python 3.11). Install application dependencies: ```bash -python -m pip install -r requirements.txt +python -m pip install -r req.txt ``` Install development dependencies: ```bash -python -m pip install -r requirements-dev.txt +python -m pip install -r req-dev.txt ``` +Run the application: + +```bash +python src/main.py +``` + +`src/main.py` is initially empty. Add application logic before using the image as a service. + ## Tests Run all tests: @@ -28,8 +36,6 @@ python -m pytest Tests are also executed automatically for Pull Requests targeting `main`. -A Pull Request must pass automated tests before it can be merged. - ## Docker Docker images are built automatically: @@ -37,11 +43,9 @@ Docker images are built automatically: - when changes are pushed to the `deploy` branch; - when a version tag matching `v*.*.*` is created. -The Python version used for Docker builds is taken from `.python-version`. - ## Project structure ```text src/ Application source code -tests/ Automated tests -``` \ No newline at end of file +tests/ Add automated tests here +```