Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Commit 1841ee2

Browse files
committed
README update
1 parent 17be881 commit 1841ee2

File tree

2 files changed

+38
-16
lines changed

2 files changed

+38
-16
lines changed

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
1-
SeedQReader
2-
---
1+
# SeedQReader
32

4-
SeedQReader is a simple tool made for communicate with airgapped Bitcoin Signer.
3+
<img src="assets/icon.png" width="64"/>
4+
5+
**SeedQReader** is a simple tool made for communicate with airgapped Bitcoin Signer.
56

67
![SeedQReader](screenshot.png)
78

89
It actually can send/receive:
910
- 1 Frame QRCodes
10-
- Multiframes QRCodes using the `Specter` format (_of_)
11+
- Multiframes QRCodes using the `Specter` format (_p M of N_)
1112
- Multiframes QRCodes using the `UR` format are partially supported (PSBT and Bytes)
13+
- Multiframes QRCodes using the `BBQR` format are partially supported (PSBT)
14+
15+
## Download our latest releases
16+
[<img src="assets/badge_github.png" alt="github releases page" width="186">](https://github.com/tadeubas/seedQReader/releases)
17+
18+
## Install
1219

13-
To install, enter the repo folder and run:
20+
To install on **Linux**, enter the repo folder and run:
1421
```
1522
# create environment to install dependencies
1623
python3 -m venv .seedqrenv
@@ -22,36 +29,51 @@ source .seedqrenv/bin/activate
2229
pip install -r requirements.txt
2330
```
2431

25-
If you get this error on Linux, please install libxcb-cursor:
32+
If you get this error on **Linux**, please install libxcb-cursor:
2633
```
2734
# qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
2835
sudo apt install libxcb-cursor0
2936
```
3037

31-
Run:
32-
```
33-
# Linux/MacOS
34-
python3 seedqreader.py
38+
To install on **Windows**:
3539
```
40+
# create environment to install dependencies
41+
python -m venv .seedqrenv
3642
37-
Run:
38-
```
39-
# Windows
40-
python seedqreader.py
43+
# activate the environment on the current cmd
44+
.seedqrenv\Scripts\activate
45+
46+
# install python dependencies on this environment
47+
pip install -r requirements.txt
4148
```
4249

43-
If you get this error on Windows, install `vcredist_x64.exe` [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784). Then uninstall and install `pyzbar` lib again:
50+
If you get this error on **Windows**, install `vcredist_x64.exe` [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784). Then uninstall and install `pyzbar` lib again:
4451
```
4552
FileNotFoundError: Could not find module 'libiconv.dll' (or one of its dependencies). Try using the full path with constructor syntax.
4653
pyimod03_ctypes.install.<locals>.PyInstallerImportError: Failed to load dynlib/dll 'libiconv.dll'. Most likely this dynlib/dll was not found when the application was frozen.
4754
[PYI-5780:ERROR] Failed to execute script 'seedqreader' due to unhandled exception!
4855
```
4956

50-
To build binaries:
57+
## Run
58+
59+
**Linux/MacOS**:
60+
```
61+
python3 seedqreader.py
62+
```
63+
64+
**Windows**:
65+
```
66+
python seedqreader.py
67+
```
68+
69+
70+
## Build binaries
71+
5172
```
5273
pip install PyInstaller
5374
python3 .ci/create-spec.py
5475
python3 -m PyInstaller seedqreader.spec
5576
```
5677

78+
5779
Project originally created by https://github.com/pythcoiner

assets/badge_github.png

15.2 KB
Loading

0 commit comments

Comments
 (0)