Skip to content

Commit 31690d3

Browse files
committed
Updated README.md and documentation home page
1 parent cd48ee4 commit 31690d3

File tree

4 files changed

+17
-5
lines changed

4 files changed

+17
-5
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# LogicalPy
22

3-
[![PyPi version](https://badgen.net/pypi/v/logicalpy/)](https://pypi.org/project/logicalpy)
3+
[![PyPI version](https://img.shields.io/pypi/v/logicalpy)](https://pypi.org/project/logicalpy)
44
[![License](https://img.shields.io/github/license/Cubix1729/logicalpy)](https://github.com/Cubix1729/logicalpy/blob/master/LICENSE)
55
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
6+
[![Python versions](https://img.shields.io/pypi/pyversions/logicalpy)](https://pypi.python.org/pypi/logicalpy)
67

78
LogicalPy is a Python library providing basic functionalities for manipulating propositional logic.
89

@@ -15,8 +16,11 @@ The main features include:
1516
- The visualisation of truth tables
1617
- The implementation of semantic notions: satisfiability, entailment...
1718
- The conversion to normal forms (NNF, CNF, or DNF)
19+
- The implementation of a Hilbert-style proof system
1820
- Automated theorem proving with the resolution procedure
1921

22+
The library also supports LaTex code generation for most of its functionalities.
23+
2024
For the complete documentation, see [https://cubix1729.github.io/logicalpy/](https://cubix1729.github.io/logicalpy/).
2125

2226
## Installation
@@ -35,7 +39,8 @@ to report a bug or request a feature, or [make a pull request](https://github.co
3539

3640
## Tests
3741

38-
To run the the tests, clone the repository, go into the `tests` directory and run `python -m unittest`.
42+
To run the the tests, first clone the repository, go into the `logicalpy` directory and locally install the project with `pip install -e .`
43+
Then, go into the `tests` directory and run `python -m unittest`.
3944

4045
## License
4146

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# LogicalPy
22

3-
[![PyPi version](https://badgen.net/pypi/v/logicalpy/)](https://pypi.org/project/logicalpy)
3+
[![PyPI version](https://badgen.net/pypi/v/logicalpy/)](https://pypi.org/project/logicalpy)
44
[![License](https://img.shields.io/github/license/Cubix1729/logicalpy)](https://github.com/Cubix1729/logicalpy/blob/master/LICENSE)
55
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
6+
[![Python versions](https://img.shields.io/pypi/pyversions/logicalpy)](https://pypi.python.org/pypi/logicalpy)
67

78
LogicalPy is a small Python library providing basic functionalities for manipulating propositional logic.
89

@@ -15,8 +16,11 @@ The main features include:
1516
- The visualisation of truth tables
1617
- The implementation of semantic notions: satisfiability, entailment...
1718
- The conversion to normal forms (NNF, CNF, or DNF)
19+
- The implementation of a Hilbert-style proof system
1820
- Automated theorem proving with the resolution procedure
1921

22+
The library also supports LaTex code generation for most of its functionalities.
23+
2024
## Installation
2125

2226
With pip:
@@ -39,7 +43,8 @@ to report a bug or request a feature, or [make a pull request](https://github.co
3943

4044
## Tests
4145

42-
To run the the tests, clone the repository, go into the `tests` directory and run `python -m unittest`.
46+
To run the the tests, first clone the repository, go into the `logicalpy` directory and locally install the project with `pip install -e .`
47+
Then, go into the `tests` directory and run `python -m unittest`.
4348

4449
## License
4550

docs/usage/constructing-formulae.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The connectives are as follow:
1616
|Implication|`->`, `` or ``|
1717
|Bi-implication|`<->`, `` or ``|
1818

19+
Example:
20+
1921
```python
2022
from logicalpy import Formula
2123

docs/usage/resolution-theorem-proving.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Resolution Theorem Proving
22

33
The [`resolution`](../api-reference/logicalpy/normal_forms.md) sub-module can be used for propositional
4-
resolution proving.
4+
resolution theorem proving.
55

66
## Usage
77

0 commit comments

Comments
 (0)