aboutsummaryrefslogtreecommitdiff
path: root/python/getdevinfo/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/getdevinfo/README')
-rw-r--r--python/getdevinfo/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/python/getdevinfo/README b/python/getdevinfo/README
new file mode 100644
index 000000000000..9dbddd80b01d
--- /dev/null
+++ b/python/getdevinfo/README
@@ -0,0 +1,10 @@
+getdevinfo (A device information gatherer for Linux and macOS)
+
+Working on both Linux and macOS, this script makes use of lshw,
+lvdisplay, and blkid (Linux), as well as diskutil (macOS) to get
+a comprehensive amount of disk information.
+
+This information is available in a structured dictionary for ease
+of use. On Linux it requires lshw, blkid, and lvdisplay to be
+installed. On Linux, you need beautifulsoup4 (bs4), and lxml to
+use this tool.