From bad253d5e496c74abe32861a2baee29f3fb9bf2b Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Mon, 1 Feb 2021 17:55:14 +0000 Subject: [PATCH] Documentation: Use the README.md for the long description --- setup.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/setup.py b/setup.py index 64d9bf2d1..6b405d441 100644 --- a/setup.py +++ b/setup.py @@ -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 = {