diff --git a/README.md b/README.md index 5240e6d..da57fca 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ A Dissect module implementing parsers for the Windows EVT, EVTX and WEVT log file formats. For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.eventlog/index.html). +## Requirements + +This project is part of the Dissect framework and requires Python. + +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). + ## Installation `dissect.eventlog` is available on [PyPI](https://pypi.org/project/dissect.eventlog/). @@ -32,12 +38,12 @@ tox ``` For a more elaborate explanation on how to build and test the project, please see [the -documentation](https://docs.dissect.tools/en/latest/contributing/developing.html#building-testing). +documentation](https://docs.dissect.tools/en/latest/contributing/tooling.html). ## Contributing The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please -refer to [the style guide](https://docs.dissect.tools/en/latest/contributing/style-guide.html). +refer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html). ## Copyright and license