Skip to content

Commit

Permalink
Fixed small typos in README
Browse files Browse the repository at this point in the history
  • Loading branch information
dcleres committed Oct 22, 2024
1 parent 5e2d624 commit fe3a575
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
{
"cSpell.words": [
"dataextraction",
"dataframe",
"DATAPATH",
"depthcolumn",
"depthcolumnentry",
"dotenv",
"fastapi",
"fitz",
"geoinformation",
"mlflow",
"pixmap",
"pydantic",
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The extraction of groundwater relies on the `scikit-image` library. This library

## License

The source code of this project is open source software, licensed under the [MIT License](LICENSE). Certain libraries in the project dependencies might be distributed under more restrictive open source licences. Most notably, [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/about.html#license-and-copyright) is available under either the AGPL license or a commercial license. These more restrictive licenses would apply when distributing this project in a single package together with its dependencies.
The source code of this project is open source software, licensed under the [MIT License](LICENSE). Certain libraries in the project dependencies might be distributed under more restrictive open source licenses. Most notably, [PyMuPDF](https://pymupdf.readthedocs.io/en/latest/about.html#license-and-copyright) is available under either the AGPL license or a commercial license. These more restrictive licenses would apply when distributing this project in a single package together with its dependencies.

## Installation
We use pip to manage the packages dependencies. We recommend using a virtual environment within which to install all dependencies.
Expand Down Expand Up @@ -363,7 +363,7 @@ Adapt the `.env.template` file to your needs, by renaming the file to `.env` and

The values from the `.env` file are automatically loaded into your Python environment thanks to the `python-dotenv` package.

To ensure that the valus from the `.env` file are also passed along when starting a Docker container, you can use the `--env-file` argument, for example:
To ensure that the values from the `.env` file are also passed along when starting a Docker container, you can use the `--env-file` argument, for example:

```bash
docker run --env-file .env -d -p 8000:8000 borehole-api
Expand Down

0 comments on commit fe3a575

Please sign in to comment.