Documentation: Use the README.md for the long description

2026-09-06 17:57:38 +02:00 · 2021-02-01 17:55:14 +00:00
parent 5cc453b7c3
commit bad253d5e4
1 changed files with 5 additions and 0 deletions
@@ -6,12 +6,17 @@ import setuptools

 from volatility3.framework import constants

+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
 setuptools.setup(name = "volatility3",
                 description = "Memory forensics framework",
                 version = constants.PACKAGE_VERSION,
                 license = "VSL",
                 keywords = "volatility memory forensics framework windows linux volshell",
                 author = "Volatility Foundation",
+                 long_description = long_description,
+                 long_description_content_type = "text/markdown",
                 author_email = "volatility@volatilityfoundation.org",
                 url = "https://volatilityfoundation.org/volatility/",
                 project_urls = {