Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more detailed installation instructions for Windows #26

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ You can collect nonces on Flipper Zero with [FlipperNested](https://github.com/A

## Installation

<details>
<summary>Linux</summary>
<br>
```bash
pip install --upgrade FlipperNested
```
Expand All @@ -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
```
</details>

<details>
<summary>Windows</summary>
<br>
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 <id>
```

8. Return to wsl by running `wsl` and run the following command to start the key recovery:

```bash
FlipperNested
```
</details>


## Usage

Expand All @@ -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
```
```