chore: cleanup build artifacts and add .gitignore
This commit is contained in:
71
README.md
71
README.md
@@ -189,6 +189,77 @@ For maximum security when generating production wallets:
|
||||
|
||||
See [playbook.md](playbook.md) for detailed air-gapped procedures.
|
||||
|
||||
## 🖥️ Platform Compatibility
|
||||
|
||||
### Makefile Targets
|
||||
|
||||
| Target | macOS | Linux | Notes |
|
||||
| -------- | ------- | ------- | ------- |
|
||||
| `make install` | ✅ | ✅ | Create venv + install deps |
|
||||
| `make test` | ✅ | ✅ | Run test suite |
|
||||
| `make vendor-macos` | ✅ | ❌ | Requires native macOS ARM64 |
|
||||
| `make vendor-linux` | ✅ | ✅ | Uses Docker (any OS) |
|
||||
| `make vendor-all` | ✅ | ⚠️ | Needs macOS for both platforms |
|
||||
| `make binary` | ✅ | ❌ | Requires `build_binary.sh` |
|
||||
| `make binary-linux` | ✅ | ✅ | Uses Docker (any OS) |
|
||||
| `make build-image` | ✅ | ✅ | Docker required |
|
||||
|
||||
### Quick Commands by Platform
|
||||
|
||||
**macOS:**
|
||||
|
||||
```bash
|
||||
make info # Show platform info
|
||||
make vendor-current # Build for current platform only
|
||||
make binary-current # Build binary for current platform
|
||||
```
|
||||
|
||||
**Linux:***
|
||||
|
||||
```bash
|
||||
make info # Show platform info
|
||||
make vendor-linux # Build Linux wheels
|
||||
make binary-linux # Build Linux binary
|
||||
```
|
||||
|
||||
***Cross-platform (requires Docker):***
|
||||
|
||||
```bash
|
||||
make vendor-linux # Works on any OS with Docker
|
||||
make binary-linux # Works on any OS with Docker
|
||||
```
|
||||
|
||||
## Quick Test
|
||||
|
||||
```bash
|
||||
# Check platform detection
|
||||
make info
|
||||
|
||||
# Build for your current platform
|
||||
make vendor-current
|
||||
|
||||
# Or just the targets you need
|
||||
make install # Works everywhere
|
||||
make test # Works everywhere
|
||||
|
||||
|
||||
## 📦 Binary Distribution
|
||||
|
||||
Pre-built standalone binaries are available for convenience (no Python required):
|
||||
|
||||
### Download Binary
|
||||
|
||||
```bash
|
||||
# macOS ARM64
|
||||
curl -LO https://github.com/user/hdwalletpy/releases/download/v1.1.0/pyhdwallet-macos-arm64
|
||||
chmod +x pyhdwallet-macos-arm64
|
||||
./pyhdwallet-macos-arm64 test
|
||||
|
||||
# Linux x86_64
|
||||
curl -LO https://github.com/user/hdwalletpy/releases/download/v1.1.0/pyhdwallet-linux
|
||||
chmod +x pyhdwallet-linux
|
||||
./pyhdwallet-linux test
|
||||
|
||||
---
|
||||
|
||||
## 🆕 What's New in v1.1.0
|
||||
|
||||
Reference in New Issue
Block a user