From d9596caf21afe05686f774f890fc645617e4a926 Mon Sep 17 00:00:00 2001
From: Mark McKinnon <mark.mckinnon@davenport.edu>
Date: Sun, 9 May 2021 09:56:18 -0400
Subject: [PATCH] Update Readme and Spec files

Updated Readme file
Added spec files for pyinstaller
---
 README.md      | 44 ++++++++++++++++++++++++++++++++++++++++++++
 cleapp.spec    | 37 +++++++++++++++++++++++++++++++++++++
 cleappGUI.spec | 37 +++++++++++++++++++++++++++++++++++++
 3 files changed, 118 insertions(+)
 create mode 100644 cleapp.spec
 create mode 100644 cleappGUI.spec

diff --git a/README.md b/README.md
index 87cf032..92a28bd 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
 # cLEAPP
 Chrome Logs Events and Protobuf Parser
+
+Details in blog post here:   
+
+## Requirements
+**Python 3.9 or above** (older versions of 3.x will also work with the exception of one or two modules)
+
+### Dependencies
+
+Dependencies for your python environment are listed in `requirements.txt`. Install them using the below command. Ensure the `py` part is correct for your environment, eg `py`, `python`, or `python3`, etc. 
+
+`py -m pip install -r requirements.txt`  
+or  
+ `pip3 install -r requirements.txt`
+
+To run on **Linux**, you will also need to install `tkinter` separately like so:
+
+`sudo apt-get install python3-tk`
+
+To install dependencies offline Troy Schnack has a neat process here:
+https://twitter.com/TroySchnack/status/1266085323651444736?s=19
+
+## Usage
+
+### CLI
+
+```
+$ python cleapp.py -t <zip | tar | fs | gz | tgz> -i <path_to_extraction> -o <path_for_report_output>
+```
+
+### GUI
+
+```
+$ python cleappGUI.py 
+```
+
+### Help
+
+```
+$ python cleapp.py --help
+```
+
+## Acknowledgements
+
+This tool is the result of a collaborative effort of many people in the DFIR community.
\ No newline at end of file
diff --git a/cleapp.spec b/cleapp.spec
new file mode 100644
index 0000000..808e450
--- /dev/null
+++ b/cleapp.spec
@@ -0,0 +1,37 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+block_cipher = None
+
+a = Analysis(['cleapp.py'],
+             pathex=[],
+             binaries=[],
+             datas=[('.\\scripts\\logo.jpg', '.\\scripts'),
+                    ('.\\scripts\\dashboard.css', '.\\scripts'),
+                    ('.\\scripts\\dark-mode.css', '.\\scripts'),
+					('.\\scripts\\dark-mode-switch.js', '.\\scripts'),					
+                    ('.\\scripts\\feather.min.js', '.\\scripts'),
+                    ('.\\scripts\\MDB-Free_4.13.0', '.\\scripts\\MDB-Free_4.13.0')],
+             hiddenimports=['simplekml', 'bs4'],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.zipfiles,
+          a.datas,
+          [],
+          name='cleapp',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          upx_exclude=[],
+          runtime_tmpdir=None,
+          console=True )
diff --git a/cleappGUI.spec b/cleappGUI.spec
new file mode 100644
index 0000000..e4dba81
--- /dev/null
+++ b/cleappGUI.spec
@@ -0,0 +1,37 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+block_cipher = None
+
+a = Analysis(['cleappGUI.py'],
+             pathex=[],
+             binaries=[],
+             datas=[('.\\scripts\\logo.jpg', '.\\scripts'),
+                    ('.\\scripts\\dashboard.css', '.\\scripts'),
+                    ('.\\scripts\\feather.min.js', '.\\scripts'),
+					('.\\scripts\\dark-mode.css', '.\\scripts'),
+					('.\\scripts\\dark-mode-switch.js', '.\\scripts'),
+                    ('.\\scripts\\MDB-Free_4.13.0', '.\\scripts\\MDB-Free_4.13.0')],
+             hiddenimports=[],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.zipfiles,
+          a.datas,
+          [],
+          name='cleappGUI',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          upx_exclude=[],
+          runtime_tmpdir=None,
+          console=False )