Skip to content

Commit 379f115

Browse files
committed
Improved README
1 parent 86b7c49 commit 379f115

File tree

1 file changed

+17
-44
lines changed

1 file changed

+17
-44
lines changed

README.md

Lines changed: 17 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
</h4>
1919

20-
The BAM Masterdata is a repository containing all the masterdata schema defining in BAM, as well as some utility functions to handle the masterdata.
20+
The BAM Masterdata repository contains the masterdata schemas defined at BAM and provides utility functions for working with them.
2121

2222
If you want to install it, do:
2323
```sh
@@ -40,14 +40,18 @@ python3 -m venv .venv
4040
source .venv/bin/activate
4141
```
4242

43-
Run the following script for Linux or MacOS:
44-
```sh
45-
./scripts/install_python_dependencies
46-
```
47-
or for Windows:
48-
```sh
49-
scripts/install_python_dependencies.bat
50-
```
43+
Run the following script depending on your OS:
44+
- *Linux/MacOS*:
45+
```sh
46+
./scripts/install_python_dependencies.sh
47+
```
48+
- *Windows*:
49+
```sh
50+
scripts/install_python_dependencies.bat
51+
```
52+
53+
**Note**: This script installs the required dependencies for development, testing, and documentation, using `uv` and `pip`.
54+
5155
### Run the tests
5256

5357
You can locally run the tests by doing:
@@ -75,53 +79,22 @@ ruff check .
7579
This will produce an output with the specific issues found. In order to auto-fix them, run:
7680

7781
```sh
78-
ruff format . --check
82+
ruff format .
7983
```
8084

8185
If some issues are not possible to fix automatically, you will need to visit the file and fix them by hand.
8286

83-
### Run the local website
84-
85-
**Under construction!**
86-
87-
<!-- ### Debugging
88-
89-
For interactive debugging of the tests, use `pytest` with the `--pdb` flag. We recommend using an IDE for debugging, e.g., _VSCode_. If that is the case, add the following snippet to your `.vscode/launch.json`:
90-
```json
91-
{
92-
"configurations": [
93-
{
94-
"name": "<descriptive tag>",
95-
"type": "debugpy",
96-
"request": "launch",
97-
"cwd": "${workspaceFolder}",
98-
"program": "${workspaceFolder}/.pyenv/bin/pytest",
99-
"justMyCode": true,
100-
"env": {
101-
"_PYTEST_RAISE": "1"
102-
},
103-
"args": [
104-
"-sv",
105-
"--pdb",
106-
"<path-to-plugin-tests>",
107-
]
108-
}
109-
]
110-
}
111-
```
112-
113-
where `<path-to-plugin-tests>` must be changed to the local path to the test module to be debugged.
114-
115-
The settings configuration file `.vscode/settings.json` automatically applies the linting and formatting upon saving the modified file. -->
11687

11788
### Documentation on Github pages
11889

119-
To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.sh`, so if you ran this script before, you don't need to do it again now):
90+
To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.*`, so if you ran this script before, you don't need to do it again now):
12091

12192
```sh
12293
uv pip install -e '[docu]'
12394
```
12495

96+
**Note**: This command installs `mkdocs`, `mkdocs-material`, and other documentation-related dependencies.
97+
12598
The first time, build the server:
12699

127100
```sh

0 commit comments

Comments
 (0)