Documentation: Use the README.md for the long description

volatilityfoundation · Feb 1, 2021 · bad253d · bad253d
1 parent 5cc453b
commit bad253d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -6,12 +6,17 @@
 
 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 = "[email protected]",
                  url = "https://volatilityfoundation.org/volatility/",
                  project_urls = {