summaryrefslogtreecommitdiffstats
path: root/python/plaso/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/plaso/README')
-rw-r--r--python/plaso/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/python/plaso/README b/python/plaso/README
new file mode 100644
index 0000000000..76c66b7012
--- /dev/null
+++ b/python/plaso/README
@@ -0,0 +1,13 @@
+plaso (Forensic Super-Timeline)
+
+Plaso is the Python based back-end engine used by tools such as log2timeline
+for automatic creation of a super timelines. The goal of log2timeline (and
+thus plaso) is to provide a single tool that can parse various log files and
+forensic artifacts from computers and related systems, such as network equipment
+to produce a single correlated timeline. This timeline can then be easily
+analysed by forensic investigators/analysts, speeding up investigations by
+correlating the vast amount of information found on an average computer system.
+
+Please pay close attention to the build order for plaso and its requirements
+(particularly dfvfs). Read the README files and do NOT rely on automated
+package tools.