Skip to content

Commit 1a65078

Browse files
committed
Corrected typos and updated readme file(s) with the new features
1 parent 8b6be69 commit 1a65078

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ The library allows to work with classical propositional logic formulae.
1212
The main features include:
1313

1414
- The construction of logical formulae either directly or from a string
15+
- The visualisation of truth tables
1516
- The implementation of semantic notions: satisfiability, entailment...
16-
- The conversion to normal forms (NNF, DNF, DNF)
17+
- The conversion to normal forms (NNF, CNF, or DNF)
1718
- Automated theorem proving with the resolution procedure
1819

1920
For the complete documentation, see [https://cubix1729.github.io/logicalpy/](https://cubix1729.github.io/logicalpy/).
@@ -32,6 +33,10 @@ Note that the library needs a Python version higher than 3.9.
3233
If you want to contribute to this (small) project, you can [open an issue](https://github.com/Cubix1729/logicalpy/issues)
3334
to report a bug or request a feature, or [make a pull request](https://github.com/Cubix1729/logicalpy/pulls).
3435

36+
## Tests
37+
38+
To run the the tests, clone the repository, go into the `tests` directory and run `python -m unittest`.
39+
3540
## License
3641

3742
This project is licensed under the MIT license.

docs/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ The library allows to work with classical propositional logic formulae.
1212
The main features include:
1313

1414
- The construction of logical formulae either directly or from a string
15+
- The visualisation of truth tables
1516
- The implementation of semantic notions: satisfiability, entailment...
16-
- The conversion to normal forms (NNF, DNF, DNF)
17+
- The conversion to normal forms (NNF, CNF, or DNF)
1718
- Automated theorem proving with the resolution procedure
1819

1920
## Installation
@@ -36,6 +37,10 @@ For a complete project reference, see the [API Reference](api-reference/logicalp
3637
If you want to contribute to this (small) project, you can [open an issue](https://github.com/Cubix1729/logicalpy/issues)
3738
to report a bug or request a feature, or [make a pull request](https://github.com/Cubix1729/logicalpy/pulls).
3839

40+
## Tests
41+
42+
To run the the tests, clone the repository, go into the `tests` directory and run `python -m unittest`.
43+
3944
## License
4045

4146
This project is licensed under the MIT license.

docs/usage/semantic-functions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Semantics functions are contained in the [`semantics`](../api-reference/logicalp
66

77
Truth tables can be built using the `TruthTable` class. Then, the string representation of the truth table
88
can be found with the `to_str` method (or directly with the `str` built-in constructor).
9-
You can use `to_latex()` or `to_markdown()` to render the truth table to LaTex or Markdown.
9+
You can also use the `to_latex()` or `to_markdown()` methods to render the truth table to LaTex or Markdown.
1010

1111
Example:
1212

1313
```python
1414
>>> from logicalpy import Formula
1515
>>> from logicalpy.semantics import TruthTable
16-
>>> formula = Formula.from_string("P v (~Q & ~P)")
17-
>>> truth_table = TruthTable(test_formula)
16+
>>> fml = Formula.from_string("P v (~Q & ~P)")
17+
>>> truth_table = TruthTable(fml)
1818
>>> print(truth_table)
1919
P Q P ∨ (¬Q ∧ ¬P)
2020
--- --- ---------------

0 commit comments

Comments
 (0)