Skip to content

Commit bad253d

Browse files
committed
Documentation: Use the README.md for the long description
1 parent 5cc453b commit bad253d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@
66

77
from volatility3.framework import constants
88

9+
with open("README.md", "r", encoding="utf-8") as fh:
10+
long_description = fh.read()
11+
912
setuptools.setup(name = "volatility3",
1013
description = "Memory forensics framework",
1114
version = constants.PACKAGE_VERSION,
1215
license = "VSL",
1316
keywords = "volatility memory forensics framework windows linux volshell",
1417
author = "Volatility Foundation",
18+
long_description = long_description,
19+
long_description_content_type = "text/markdown",
1520
author_email = "[email protected]",
1621
url = "https://volatilityfoundation.org/volatility/",
1722
project_urls = {

0 commit comments

Comments
 (0)