Skip to content

Commit

Permalink
Update README.md (#21)
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 authored May 16, 2023
1 parent 3094fcd commit a2197b0
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 @@ -4,6 +4,12 @@ A Dissect module implementing a parser for Microsofts Extensible Storage Engine
Active Directory, Exchange and Windows Update. For more information, please see [the
documentation](https://docs.dissect.tools/en/latest/projects/dissect.esedb/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.esedb` is available on [PyPI](https://pypi.org/project/dissect.esedb/).
Expand Down Expand Up @@ -47,12 +53,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 a2197b0

Please # to comment.