diff --git a/README.md b/README.md index 6a0674f..515de2a 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,19 @@ To get started, rename all instances of `project_name` in the codebase to the na ## Development Environment Setup -To set up your development environment, use the provided Docker Compose config in the base directory. +To set up your development environment, use the provided Docker Compose config in the base directory. 1. Run `docker compose up` to start the Flask app in a Docker container. -2. To set up pre-commit hooks, ensure that `pre-commit` is installed. You can install it using `pip install pre-commit`. +2. To set up pre-commit hooks, ensure that `pre-commit` is installed. You can install it using: -3. Run `pre-commit install` to install the hooks defined in `.pre-commit-config.yml`. This ensures that code is properly formatted and passes linting checks before commits are made. + ```bash + pip install pre-commit + ``` + +3. To install the hooks defined in `.pre-commit-config.yml`, run: + + ```bash + pre-commit install + ``` + This ensures that code is properly formatted and passes linting checks before commits are made.