From 6fb82dc8d04a377508a40a53078f5d17f8087434 Mon Sep 17 00:00:00 2001 From: kaibot Date: Thu, 9 Apr 2026 11:47:10 +0000 Subject: [PATCH] docs(README): Remove version references, remove PyQt mentions, update wallet_util steps, simplify contributing section --- README.md | 67 +++++++++++++------------------------------------------ 1 file changed, 16 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index c2e76a6..80f7213 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ - Download the latest `bal-electrum-plugin-vX.X.X.zip` file 2. **Install in Electrum** - - Open Electrum Bitcoin wallet version **4.7.2 or later** + - Open Electrum Bitcoin wallet - Go to **Tools → Plugins** - Click **Add** - Select the downloaded `.zip` file @@ -135,10 +135,15 @@ bal-electrum-plugin/ - **⚠️ Emergency tools only**: For fixing wallet database issues - **Purpose**: Handle compatibility across different Electrum walletdb versions - **Usage**: Advanced users only, requires manual installation -- **Installation**: Copy files to Electrum's plugin directory and load Electrum's virtualenv -- **Files**: - - `bal_wallet_utils.py`: Core wallet database utilities - - `bal_wallet_utils_qt.py`: Qt-specific wallet utilities +- **Installation Steps**: + 1. Copy `wallet_util/` files to Electrum's plugin directory + 2. Load Electrum's virtualenv + 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) - **User-friendly wizards**: Step-by-step setup interface @@ -224,8 +229,7 @@ Executor: "Charlie Executor" (fee: 0.02 BTC fixed) ## 🛠️ Development ### Prerequisites -- **Electrum Bitcoin wallet**: Version **4.7.2 or later** -- **Python**: 3.7+ +- Electrum Bitcoin wallet ### Setup Development Environment @@ -247,7 +251,7 @@ zip -r bal-electrum-plugin-dev.zip bal_electrum_plugin/ - **Installation Steps**: 1. Copy `wallet_util/` files to Electrum's plugin directory 2. Load Electrum's virtualenv - 3. Restart Electrum + 3. Run `./bal_wallet_utils_qt.py` - **Risk**: Advanced operations that can affect wallet data - **Documentation**: Limited to inline code comments @@ -269,7 +273,7 @@ zip -r bal-electrum-plugin-dev.zip bal_electrum_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 #### Plugin Not Showing in Electrum -- ✅ Verify Electrum version is **4.7.2 or later** - ✅ Check zip contains `bal_electrum_plugin/` directory at root - ✅ Verify directory structure inside zip is correct - ✅ Restart Electrum completely after installation @@ -320,6 +323,7 @@ The plugin uses Electrum's existing virtualenv. No additional dependencies neede #### wallet_util/ Not Working - ✅ Copy files to Electrum's plugin directory - ✅ Load Electrum's virtualenv before using +- ✅ Run `./bal_wallet_utils_qt.py` - ✅ Only use for emergency wallet fixes - ✅ Backup wallet before using wallet utilities @@ -327,44 +331,7 @@ The plugin uses Electrum's existing virtualenv. No additional dependencies neede ## 🤝 Contributing -We welcome contributions! Please follow these guidelines: - -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 -``` +Thanks for considering contributing! --- @@ -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) - **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) --- @@ -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. **💡 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.