Skip to content

Commit

Permalink
Update Installation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
3rdIteration authored Nov 27, 2024
1 parent abf267e commit 8e26358
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ The Install command is:

**Once you have installed Python via Brew, you will need to run both Python and PIP with commands that include the full version numnber. (eg: python3.12 and pip3.12)**

3) Install Rust (Optional, but needed for requirements-full modules)

curl https://sh.rustup.rs -sSf | sh

## 3) Install requirements via Python Pip ##

Once both Python3 and PIP have been installed, you can install the requirements for BTCRecover.
Expand All @@ -106,6 +110,10 @@ If when run this command, you get an error message similar to **error: externall

Note: If you use Python for other things beyond BTCRecover, then the `--break-system-packages` could cause other issues, but in such situations, managing your python virtual environments for your specific system is beyond the scope of this documentation.

If you are running Python 3.13 and get a build error you may also need to set the following environment variable.

export PYO3_USE_ABI3_FORWARD_COMPATIBILITY=1

### Packages for Extended Wallet Support
Depending on your wallet type, you may also want to install the packages required for full wallet support. This is a much larger download and may also require that you install additional software on your PC for these packages to build and install.

Expand Down

0 comments on commit 8e26358

Please sign in to comment.