@@ -20,9 +20,9 @@ cd logicalpy
2020In order to contribute to the project, you will need to install it locally.
2121
2222 - You can first optionally create a virtual environment
23- - Then, locally install the project in editable mode with:
23+ - Then, locally install the project in editable mode and with all of the development dependencies using :
2424 ```
25- pip install -e .
25+ pip install -e .[dev]
2626 ```
2727
2828### 3. Make and commit your changes
@@ -41,14 +41,21 @@ as well as any relevant context.
4141Your pull request will then be reviewed, and once it has been approved, it will be
4242merged to the main project 🎉.
4343
44+ ## Project dependencies
45+
46+ The project uses:
47+
48+ - `lark` for parsing logical formulae
49+ - `tabulate` for making truth tables
50+
4451## Code style and testing guidelines
4552
4653To meet the project's code style, please format the code with `black` using the command
4754`black <path-to-the-code>`. (The maximum line length used is the default one, i.e. 88
4855characters).
4956
5057If you implement any new feature or change an existing one, please update the tests in
51- consequence.
58+ consequence. They are written with the `unittest` library of the Python standard library.
5259
5360For any modification you make, ensure the tests still pass by running (from the main folder
5461or from the `tests` folder):
@@ -57,6 +64,18 @@ or from the `tests` folder):
5764python -m unittest
5865```
5966
67+ The project uses `coverage` to generate test coverage reports. The coverage badge present in both
68+ the README.md and the documentation homepage is then generated with the `coverage-badge`
69+ Python package.
70+
71+ ## Documentation changes
72+
73+ The documentation is written in Markdown and built using `mkdocs` (more precisely with `mkdocs-material`).
74+ The `mkdocs` documentation configuration is in the file `mkdocs.yml`.
75+
76+ If you make changes to the documentation, you can use `mkdocs serve` to build the documentation locally and
77+ view it your browser at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
78+
6079## Opening an issue
6180
6281If you find a bug or issue in the project, please [open an issue](https://github.com/Cubix1729/logicalpy/issues/new)
0 commit comments