davide/pallectrum
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Davide Grilli
2026-02-16 17:46:01 +01:00
committed by davide3011
parent 2cebb4ca8a
commit 0018091c13
1 changed files with 49 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@@ -53,9 +53,7 @@ If you want to run Pallectrum from source, you'll need Python 3.10 or higher.
#### Windows
**Prerequisites:**
- Python 3.10+ installed from [python.org](https://www.python.org/downloads/)
**Prerequisites:** Python 3.10+ installed from [python.org](https://www.python.org/downloads/)
**Setup with Virtual Environment:**
@@ -88,17 +86,20 @@ python run_electrum gui -g qml
#### Linux (Ubuntu/Debian)
**Install Prerequisites:**
##### Install Prerequisites
```bash
# System packages
sudo apt update
sudo apt install -y python3-venv python3-pip build-essential python3-dev
sudo apt install -y libffi-dev libssl-dev libsecp256k1-dev
sudo apt install -y libpulse0 # required by QtMultimedia (QML GUI)
sudo apt install -y \
python3-venv python3-pip python3-dev build-essential \
libffi-dev libssl-dev libsecp256k1-dev \
libpulse0
```
**Setup with Virtual Environment:**
---
##### Standard Installation (x86_64)
```bash
# Clone repository
@@ -109,64 +110,73 @@ cd pallectrum
python3 -m venv env
source env/bin/activate
# Upgrade pip and install dependencies
# Upgrade pip
python3 -m pip install --upgrade pip
pip install -e ".[gui,crypto]"
# Install project with GUI + crypto extras
pip install -e "[gui,crypto]"
# Run with Qt GUI
python run_electrum
```
##### Note for ARM64
---
On ARM64, PyQt6 6.9+ wheels are not available on PyPI. Install with pinned versions:
##### ARM64 (aarch64)
> PyQt6 ≥ 6.9 wheels are not available for ARM64 on PyPI. Use pinned versions.
```bash
# Clone repository (if not already done)
git clone https://github.com/palladium-coin/pallectrum.git
cd pallectrum
# Create and activate virtual environment
python3 -m venv env
source env/bin/activate
# Upgrade pip and install dependencies
# Upgrade pip
python3 -m pip install --upgrade pip
# Base requirements
pip install -r contrib/requirements/requirements.txt
pip install "cryptography>=2.6"
# Install PyQt6 (ARM64-compatible versions)
pip install --only-binary PyQt6,PyQt6-Qt6 \
'PyQt6>=6.7.0,<6.8.0' \
'PyQt6-Qt6>=6.7.0,<6.8.0' \
'PyQt6-sip==13.10.2'
# Install in development mode (without gui extra)
pip install -e .
# Run
python3 run_electrum
```
##### Optional: QML GUI on Linux (simulates Android interface)
```bash
pip install ".[qml_gui]"
python run_electrum gui -g qml
```
###### ARM64 (aarch64) with pinned PyQt6
```bash
pip install -r contrib/requirements/requirements.txt
pip install "cryptography>=2.6"
# Install ARM64-compatible PyQt6 versions
pip install --only-binary PyQt6,PyQt6-Qt6,PyQt6-sip \
"PyQt6>=6.7.0,<6.8.0" \
"PyQt6-Qt6>=6.7.0,<6.8.0" \
"PyQt6-sip==13.10.2"
# Install project (development mode)
pip install -e .
# Run
python run_electrum
```
---
##### Optional: QML GUI (Android-like interface)
###### x86_64
```bash
pip install "[qml_gui]"
python run_electrum gui -g qml
```
For detailed installation instructions, including dependencies and platform-specific notes, see the [original Electrum documentation](README-ELECTRUM.md#getting-started).
###### ARM64
```bash
python run_electrum gui -g qml
```
---
For detailed installation instructions, including dependencies and platform-specific notes, see the original Electrum documentation:
[README-ELECTRUM.md#getting-started](README-ELECTRUM.md#getting-started)
## User Guide