From 6c7f1b0468919f3f6a1d5a3fb5cf5ff3a0bbc106 Mon Sep 17 00:00:00 2001 From: martinvanhensbergen Date: Tue, 16 May 2023 15:25:56 +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 9b4d90a..c040a35 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ A Dissect module implementing a parser for the NTFS file system, used by the Windows operating system. For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.ntfs/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.ntfs` is available on [PyPI](https://pypi.org/project/dissect.ntfs/). @@ -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