diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..ff16cde --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,56 @@ +# Installation + +Install the following packages: + + $ apt-get install python-dev libusb-1.0-0-dev libudev-dev + $ pip install -U setuptools pip + +Make sure you are running the latest firmware version on your hardware device. +Currently the following firmware versions are supported: + + * [TREZOR](https://wallet.trezor.io/data/firmware/releases.json): `1.4.2+` + * [KeepKey](https://github.com/keepkey/keepkey-firmware/releases): `3.0.17+` + * [Ledger Nano S](https://github.com/LedgerHQ/blue-app-ssh-agent): `0.0.3+` + +## TREZOR + +Make sure that your `udev` rules are configured [correctly](https://doc.satoshilabs.com/trezor-user/settingupchromeonlinux.html#manual-configuration-of-udev-rules). +Then, install the latest [trezor_agent](https://pypi.python.org/pypi/trezor_agent) package: + + $ pip install trezor_agent + +Or, directly from the latest source code: + + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/trezor + +If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28). + +## KeepKey + +Make sure that your `udev` rules are configured [correctly](https://support.keepkey.com/support/solutions/articles/6000037796-keepkey-wallet-is-not-being-recognized-by-linux). +Then, install the latest [keepkey_agent](https://pypi.python.org/pypi/keepkey_agent) package: + + $ pip install keepkey_agent + +Or, directly from the latest source code: + + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/keepkey + +## Ledger Nano S + +Make sure that your `udev` rules are configured [correctly](http://support.ledgerwallet.com/knowledge_base/topics/ledger-wallet-is-not-recognized-on-linux). +Then, install the latest [ledger_agent](https://pypi.python.org/pypi/ledger_agent) package: + + $ pip install ledger_agent + +Or, directly from the latest source code: + + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/ledger + +## Troubleshooting + +If there is an import problem with the installed `protobuf` package, +see [this issue](https://github.com/romanz/trezor-agent/issues/28) for fixing it. diff --git a/README.md b/README.md index 1d548d7..8e0ccbe 100644 --- a/README.md +++ b/README.md @@ -14,55 +14,7 @@ See SatoshiLabs' blog posts about this feature: ## Installation -Install the following packages: - - $ apt-get install python-dev libusb-1.0-0-dev libudev-dev - $ pip install -U setuptools pip - -Make sure you are running the latest firmware version on your hardware device. -Currently the following firmware versions are supported: - - * [TREZOR](https://wallet.trezor.io/data/firmware/releases.json): `1.4.2+` - * [KeepKey](https://github.com/keepkey/keepkey-firmware/releases): `3.0.17+` - * [Ledger Nano S](https://github.com/LedgerHQ/blue-app-ssh-agent): `0.0.3+` - -### TREZOR - -Make sure that your `udev` rules are configured [correctly](https://doc.satoshilabs.com/trezor-user/settingupchromeonlinux.html#manual-configuration-of-udev-rules). -Then, install the latest [trezor_agent](https://pypi.python.org/pypi/trezor_agent) package: - - $ pip install trezor_agent - -Or, directly from the latest source code: - - $ git clone https://github.com/romanz/trezor-agent - $ pip install --user -e trezor-agent/agents/trezor - -If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28). - -### KeepKey - -Make sure that your `udev` rules are configured [correctly](https://support.keepkey.com/support/solutions/articles/6000037796-keepkey-wallet-is-not-being-recognized-by-linux). -Then, install the latest [keepkey_agent](https://pypi.python.org/pypi/keepkey_agent) package: - - $ pip install keepkey_agent - -Or, directly from the latest source code: - - $ git clone https://github.com/romanz/trezor-agent - $ pip install --user -e trezor-agent/agents/keepkey - -### Ledger Nano S - -Make sure that your `udev` rules are configured [correctly](http://support.ledgerwallet.com/knowledge_base/topics/ledger-wallet-is-not-recognized-on-linux). -Then, install the latest [ledger_agent](https://pypi.python.org/pypi/ledger_agent) package: - - $ pip install ledger_agent - -Or, directly from the latest source code: - - $ git clone https://github.com/romanz/trezor-agent - $ pip install --user -e trezor-agent/agents/ledger +See the [following instructions](INSTALL.md) for TREZOR, Keepkey and Ledger Nano S devices. ## Usage @@ -73,11 +25,6 @@ For GPG, see the [following instructions](README-GPG.md). See [here](https://github.com/romanz/python-trezor#pin-entering) for PIN entering instructions. -## Troubleshooting - -If there is an import problem with the installed `protobuf` package, -see [this issue](https://github.com/romanz/trezor-agent/issues/28) for fixing it. - ### Gitter Questions, suggestions and discussions are welcome: [![Chat](https://badges.gitter.im/romanz/trezor-agent.svg)](https://gitter.im/romanz/trezor-agent)