From 2df0c6f4cecba865ce3ba02222e7b63425e38eb7 Mon Sep 17 00:00:00 2001 From: martinvanhensbergen Date: Tue, 16 May 2023 15:26:20 +0200 Subject: [PATCH] Update README.md Add Requirements section with URL to the supported Python versions. Update links to main documentation. (DIS-1986) --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fec829..683b652 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ A Dissect module implementing a parsers for the SQLite database file format, com configuration data. For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.sql/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.sql` is available on [PyPI](https://pypi.org/project/dissect.sql/). @@ -33,12 +39,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