forked from bitcoinafterlife/bal-electrum-plugin
docs(README): Remove version references, remove PyQt mentions, update wallet_util steps, simplify contributing section
This commit is contained in:
67
README.md
67
README.md
@@ -13,7 +13,7 @@
|
|||||||
- Download the latest `bal-electrum-plugin-vX.X.X.zip` file
|
- Download the latest `bal-electrum-plugin-vX.X.X.zip` file
|
||||||
|
|
||||||
2. **Install in Electrum**
|
2. **Install in Electrum**
|
||||||
- Open Electrum Bitcoin wallet version **4.7.2 or later**
|
- Open Electrum Bitcoin wallet
|
||||||
- Go to **Tools → Plugins**
|
- Go to **Tools → Plugins**
|
||||||
- Click **Add**
|
- Click **Add**
|
||||||
- Select the downloaded `.zip` file
|
- Select the downloaded `.zip` file
|
||||||
@@ -135,10 +135,15 @@ bal-electrum-plugin/
|
|||||||
- **⚠️ Emergency tools only**: For fixing wallet database issues
|
- **⚠️ Emergency tools only**: For fixing wallet database issues
|
||||||
- **Purpose**: Handle compatibility across different Electrum walletdb versions
|
- **Purpose**: Handle compatibility across different Electrum walletdb versions
|
||||||
- **Usage**: Advanced users only, requires manual installation
|
- **Usage**: Advanced users only, requires manual installation
|
||||||
- **Installation**: Copy files to Electrum's plugin directory and load Electrum's virtualenv
|
- **Installation Steps**:
|
||||||
- **Files**:
|
1. Copy `wallet_util/` files to Electrum's plugin directory
|
||||||
- `bal_wallet_utils.py`: Core wallet database utilities
|
2. Load Electrum's virtualenv
|
||||||
- `bal_wallet_utils_qt.py`: Qt-specific wallet utilities
|
3. Run `./bal_wallet_utils_qt.py`
|
||||||
|
|
||||||
|
- **Risk**: Advanced operations that can affect wallet data
|
||||||
|
- **Documentation**: Limited to inline code comments
|
||||||
|
|
||||||
|
**Normal operation does NOT require wallet_util/ files.**
|
||||||
|
|
||||||
### Main Interface (qt.py)
|
### Main Interface (qt.py)
|
||||||
- **User-friendly wizards**: Step-by-step setup interface
|
- **User-friendly wizards**: Step-by-step setup interface
|
||||||
@@ -224,8 +229,7 @@ Executor: "Charlie Executor" (fee: 0.02 BTC fixed)
|
|||||||
## 🛠️ Development
|
## 🛠️ Development
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- **Electrum Bitcoin wallet**: Version **4.7.2 or later**
|
- Electrum Bitcoin wallet
|
||||||
- **Python**: 3.7+
|
|
||||||
|
|
||||||
### Setup Development Environment
|
### Setup Development Environment
|
||||||
|
|
||||||
@@ -247,7 +251,7 @@ zip -r bal-electrum-plugin-dev.zip bal_electrum_plugin/
|
|||||||
- **Installation Steps**:
|
- **Installation Steps**:
|
||||||
1. Copy `wallet_util/` files to Electrum's plugin directory
|
1. Copy `wallet_util/` files to Electrum's plugin directory
|
||||||
2. Load Electrum's virtualenv
|
2. Load Electrum's virtualenv
|
||||||
3. Restart Electrum
|
3. Run `./bal_wallet_utils_qt.py`
|
||||||
|
|
||||||
- **Risk**: Advanced operations that can affect wallet data
|
- **Risk**: Advanced operations that can affect wallet data
|
||||||
- **Documentation**: Limited to inline code comments
|
- **Documentation**: Limited to inline code comments
|
||||||
@@ -269,7 +273,7 @@ zip -r bal-electrum-plugin-dev.zip bal_electrum_plugin/
|
|||||||
|
|
||||||
### Running the Plugin
|
### Running the Plugin
|
||||||
|
|
||||||
The plugin uses Electrum's existing virtualenv. No additional dependencies needed.
|
The plugin uses Electrum's existing virtualenv.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -278,7 +282,6 @@ The plugin uses Electrum's existing virtualenv. No additional dependencies neede
|
|||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
#### Plugin Not Showing in Electrum
|
#### Plugin Not Showing in Electrum
|
||||||
- ✅ Verify Electrum version is **4.7.2 or later**
|
|
||||||
- ✅ Check zip contains `bal_electrum_plugin/` directory at root
|
- ✅ Check zip contains `bal_electrum_plugin/` directory at root
|
||||||
- ✅ Verify directory structure inside zip is correct
|
- ✅ Verify directory structure inside zip is correct
|
||||||
- ✅ Restart Electrum completely after installation
|
- ✅ Restart Electrum completely after installation
|
||||||
@@ -320,6 +323,7 @@ The plugin uses Electrum's existing virtualenv. No additional dependencies neede
|
|||||||
#### wallet_util/ Not Working
|
#### wallet_util/ Not Working
|
||||||
- ✅ Copy files to Electrum's plugin directory
|
- ✅ Copy files to Electrum's plugin directory
|
||||||
- ✅ Load Electrum's virtualenv before using
|
- ✅ Load Electrum's virtualenv before using
|
||||||
|
- ✅ Run `./bal_wallet_utils_qt.py`
|
||||||
- ✅ Only use for emergency wallet fixes
|
- ✅ Only use for emergency wallet fixes
|
||||||
- ✅ Backup wallet before using wallet utilities
|
- ✅ Backup wallet before using wallet utilities
|
||||||
|
|
||||||
@@ -327,44 +331,7 @@ The plugin uses Electrum's existing virtualenv. No additional dependencies neede
|
|||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
We welcome contributions! Please follow these guidelines:
|
Thanks for considering contributing!
|
||||||
|
|
||||||
1. **Fork the repository** on Gitea
|
|
||||||
2. **Create feature branch**: `git checkout -b feature/your-feature`
|
|
||||||
3. **Follow PEP 8** style guide strictly
|
|
||||||
4. **Write clear commit messages** following Conventional Commits
|
|
||||||
5. **Update documentation** for new features
|
|
||||||
6. **Open Pull Request** to `main` branch
|
|
||||||
|
|
||||||
### Development Workflow
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Fork repository on Gitea
|
|
||||||
|
|
||||||
# Clone your fork
|
|
||||||
git clone https://bitcoin-after.life/gitea/YOUR_USERNAME/bal-electrum-plugin.git
|
|
||||||
cd bal-electrum-plugin
|
|
||||||
|
|
||||||
# Add upstream remote
|
|
||||||
git remote add upstream https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin.git
|
|
||||||
|
|
||||||
# Create feature branch
|
|
||||||
git checkout -b feature/your-feature-name
|
|
||||||
|
|
||||||
# Make changes to bal_electrum_plugin/ files
|
|
||||||
# ...
|
|
||||||
|
|
||||||
# Test in Electrum 4.7.2+
|
|
||||||
|
|
||||||
# Commit changes with clear message
|
|
||||||
git add .
|
|
||||||
git commit -m "feat(heirs): add percentage validation for heir distribution"
|
|
||||||
|
|
||||||
# Push to your fork
|
|
||||||
git push origin feature/your-feature-name
|
|
||||||
|
|
||||||
# Open Pull Request on Gitea
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -378,7 +345,7 @@ MIT License - see [LICENSE](LICENSE) for details.
|
|||||||
|
|
||||||
- **Repository**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin)
|
- **Repository**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin)
|
||||||
- **Releases**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/releases](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/releases)
|
- **Releases**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/releases](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/releases)
|
||||||
- **Issues**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/issues](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/issues)
|
- **Issues**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/issues](https://bitcoin-after.like/bitcoinafterlife/bal-electrum-plugin/issues)
|
||||||
- **Discussions**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/discussions](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/discussions)
|
- **Discussions**: [https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/discussions](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/discussions)
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -388,5 +355,3 @@ MIT License - see [LICENSE](LICENSE) for details.
|
|||||||
**🔒 Security**: Never share your seed phrase or private keys. This plugin only creates transactions, it doesn't store your keys.
|
**🔒 Security**: Never share your seed phrase or private keys. This plugin only creates transactions, it doesn't store your keys.
|
||||||
|
|
||||||
**💡 Note**: The executor fee is a fixed BTC amount included in the transaction output. The executor is financially incentivized to broadcast the transaction and ensure it confirms on the Bitcoin network.
|
**💡 Note**: The executor fee is a fixed BTC amount included in the transaction output. The executor is financially incentivized to broadcast the transaction and ensure it confirms on the Bitcoin network.
|
||||||
|
|
||||||
**📋 Requirements**: Electrum 4.7.2+ only. No additional dependencies or configuration sections needed.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user