From f51b8949de80da0b54cfe7ef18ccc2a68030cc17 Mon Sep 17 00:00:00 2001 From: Jonathan Herrewijnen Date: Wed, 7 Aug 2024 19:11:56 +0200 Subject: [PATCH] Update repository readme, requirements and add more flexible gitignore for frederics exynos-usbdl --- .gitignore | 1 + README.md | 4 +++- documentation/source/conf.py | 1 - requirements.txt | 10 ++++++++++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index de94b74..27e5fc7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ dump/ *.bin *.a +!dump/exynos-usbdl/ diff --git a/README.md b/README.md index 8e7a2fa..e0f8224 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,6 @@ python3 -m venv venv pip install -r requirements.txts ``` -To get to work, run `source/exploit/exploit.py` \ No newline at end of file +To get to work, run `source/exploit/exploit.py` + +To view documentation, ensure you have sphinx installed. If not, run `sudo apt install python3-sphinx`. Then proceed to build the documentation by running `make livehtml`. \ No newline at end of file diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 71a2f9e..6238d8d 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -14,7 +14,6 @@ author = 'Eljakim, Jonathan' # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ 'myst_parser', - 'sphinx_rtd_theme', 'sphinx.ext.todo', 'sphinxcontrib.confluencebuilder', "sphinxcontrib.drawio", diff --git a/requirements.txt b/requirements.txt index 435a090..e26a33f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,13 @@ +sphinx +sphinx-autobuild sphinx-rtd-theme sphinxcontrib.confluencebuilder sphinxcontrib.drawio +myst_parser +libusb1 +pyusb +ghidra_bridge +tqdm +pyhidra +sphinxcontrib.confluencebuilder +sphinxcontrib.drawio \ No newline at end of file