From 396cdd315b37355184d5af53841e992c4929df44 Mon Sep 17 00:00:00 2001 From: Ivan Holmes Date: Thu, 14 May 2020 13:23:05 +0100 Subject: [PATCH] update readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 9030543..6d6a32e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # x230patcher X230 automated UEFI firmware patcher using CH341A and SOIC clip. For firmware version 2.7.5 only! + +## Initial setup +You will need to obtain a version of UEFIPatch that runs on your operating system. In the file `romtools.py` there is a variable called `UEFIPATCH_LOCATION`. Please set this to the path (relative or absolute) of your UEFIPatch executable, which can be downloaded from [here](https://github.com/LongSoft/UEFITool/releases). **Be sure to download version 0.28.0 and _NOT_ version A57 or A56 etc, these are from a separate codebase and do not yet support patching.** +After this you are ready to go. + +# How to use +1. Open a terminal and cd into the directory under which your 'projects' are stored +2. Run auto.py (probably have to do this using its full path) +3. Follow the instructions on screen +4. Profit?? \ No newline at end of file