From 319467f5b24f06aac1cee51f31d9fc351cac929c Mon Sep 17 00:00:00 2001 From: Jans George Rautenbach <14095706+Koellewe@users.noreply.github.com> Date: Mon, 7 Jun 2021 20:30:25 +0200 Subject: [PATCH] Improved README Updated structure, added links, and added deprecation warning for V3. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7036a18..9515879 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ Profiles ======== -Volatility profiles for Linux and Mac OS X +[Volatility](https://github.com/volatilityfoundation/volatility) profiles for Linux and Mac OS X -Each of these profiles is implemented as a zip file. You can enable them individually with your Volatility installation by copying Linux profiles to volatility/plugins/overlays/linux and Mac profiles to volatility/plugins/overlays/mac. +Each of these profiles is implemented as a zip file. You can enable them individually with your Volatility installation by copying Linux profiles to `volatility/plugins/overlays/linux` and Mac profiles to `volatility/plugins/overlays/mac`. -NOTE: Only enable the profiles you plan to use. If you copy all zip files into the aforementioned directories, Volatility will be extremely slow to load. +## Important notes -WARNING: These profiles may not be fully tested (or tested at all). Use at your own risk. If you encounter problems, please report them through the issue tracker: https://github.com/volatilityfoundation/profiles/issues. +- Only enable the profiles you plan to use. If you copy all zip files into the aforementioned directories, Volatility will be extremely slow to load. +- [Volatility 3](https://github.com/volatilityfoundation/volatility3/) does not use profiles, but instead uses [`Symbol Tables`](https://volatility3.readthedocs.io/en/latest/basics.html#symbol-tables). +- These profiles may not be fully tested (or tested at all). Use at your own risk. If you encounter problems, please report them through the issue tracker: https://github.com/volatilityfoundation/profiles/issues.