Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add Requirements section with URL to the supported Python versions.

Update links to main documentation.

(DIS-1986)
  • Loading branch information
martinvanhensbergen committed May 16, 2023
1 parent afaa40f commit 6c7f1b0
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 6c7f1b0

Please sign in to comment.