Skip to content

Commit 4cfb1bd

Browse files
author
martinvanhensbergen
authored
Update README.md
Add Requirements section with URL to the supported Python versions. Update links to main documentation. (DIS-1986)
1 parent 062a32b commit 4cfb1bd

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ A Dissect module implementing a parser for the Object Linking & Embedding (OLE)
44
editors on Windows operating systems. For more information, please see [the
55
documentation](https://docs.dissect.tools/en/latest/projects/dissect.ole/index.html).
66

7+
## Requirements
8+
9+
This project is part of the Dissect framework and requires Python.
10+
11+
Information on the supported Python versions can be found in the Getting Started section of [the documentation](https://docs.dissect.tools/en/latest/index.html#getting-started).
12+
713
## Installation
814

915
`dissect.ole` is available on [PyPI](https://pypi.org/project/dissect.ole/).
@@ -33,12 +39,12 @@ tox
3339
```
3440

3541
For a more elaborate explanation on how to build and test the project, please see [the
36-
documentation](https://docs.dissect.tools/en/latest/contributing/developing.html#building-testing).
42+
documentation](https://docs.dissect.tools/en/latest/contributing/tooling.html).
3743

3844
## Contributing
3945

4046
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
41-
refer to [the style guide](https://docs.dissect.tools/en/latest/contributing/style-guide.html).
47+
refer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html).
4248

4349
## Copyright and license
4450

0 commit comments

Comments
 (0)