From a890aaeb2f9230c83d6781283549160455522866 Mon Sep 17 00:00:00 2001
From: helloyanis <40769776+helloyanis@users.noreply.github.com>
Date: Tue, 10 Dec 2024 10:37:53 +0100
Subject: [PATCH] Add more detailed installation instructions for Windows
Seriously, I spent a day trying to get this thing working in Windows!
---
README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 45 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index eb798c6..f2f542c 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,9 @@ You can collect nonces on Flipper Zero with [FlipperNested](https://github.com/A
## Installation
+
+Linux
+
```bash
pip install --upgrade FlipperNested
```
@@ -17,6 +20,47 @@ pip install --upgrade pyserial protobuf wheel setuptools
python setup.py sdist bdist_wheel
pip install --user --upgrade --find-links=./dist FlipperNested
```
+
+
+
+Windows
+
+First, install Windows Subsystem for Linux (WSL) and Ubuntu. To do so,
+
+1. Access the "Add or remove Windows features" menu by searching for it in the start menu.
+2. Check the box next to "Windows Subsystem for Linux" and click "OK".
+3. Open the terminal and run the following command to install Ubuntu:
+
+```bash
+wsl --install Ubuntu
+```
+
+4. Pick an username and a password when prompted.
+5. Run the following command to update the package list and install the necessary packages:
+
+```bash
+sudo apt update && sudo apt upgrade -y && sudo apt install python3 python3-pip pipx git -y && pipx install FlipperNested && pipx ensurepath
+```
+
+6. Plug in your flipper, close the terminal and open a new *administrator* terminal, and install this utility to let your flipper connect to WSL:
+
+```bash
+winget install usbipd && usbipd list
+```
+
+7. Your flipper will be listed as "Serial USB Device" or similar. Take note of its BUSID, then run the following command to connect it to WSL:
+
+```bash
+usbipd attach --wsl --busid
+```
+
+8. Return to wsl by running `wsl` and run the following command to start the key recovery:
+
+```bash
+FlipperNested
+```
+
+
## Usage
@@ -43,4 +87,4 @@ options:
--save Debug: Save nonces/keys from Flipper
--preserve Debug: Don't remove nonces after recovery
--file FILE Debug: Recover keys from local .nonces file
-```
\ No newline at end of file
+```