From 4b0e057d4e91bb987fbc856a6e4452abf8ce02d8 Mon Sep 17 00:00:00 2001 From: matejcik Date: Tue, 10 Apr 2018 11:40:06 +0200 Subject: [PATCH] docs: contributing info for the new submodule --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index bdf8c781d9..02f75eadab 100644 --- a/README.rst +++ b/README.rst @@ -77,3 +77,23 @@ Example: your PIN is **1234** and TREZOR is displaying the following: === === === You have to enter: **3795** + + +Contributing +------------ + +Python-trezor pulls coins info and protobuf messages from `trezor-common `_ repository. If you are +developing new features for Trezor, you will want to start there. Once your changes are accepted to ``trezor-common``, you can make a PR +against this repository. Don't forget to update the submodule with: + +.. code:: + + git submodule update --init --remote + +Then, rebuild the protobuf messages and get ``coins.json`` by running: + +.. code:: + + python3 setup.py prebuild + +To get support for BTC-like coins, these steps are enough and no further changes to the library are necessary.