Skip to content

Commit

Permalink
Readme clarity improvements
Browse files Browse the repository at this point in the history
Reword the python readme based on suggestion from comments.

Signed-off-by: RostarMarek <rostarmarek@gmail.com>

chore: Readme clarity improvements

Added a few parts to readme files to incentivize using
Docker setup instead of local environment.

Signed-off-by: RostarMarek <rostarmarek@gmail.com>
  • Loading branch information
RostarMarek committed Aug 27, 2024
1 parent e19b803 commit 89805cd
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
16 changes: 16 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,28 @@ make dockerinit
make dockerdev
```

If you do not want to build the docker image locally, or are not working on it, it may be more straightforward to
pull the image from docker instead of building it. This should be a bit faster and there should not be any issues with
`make dockerdev` expecting specific version of the image.

```sh
docker pull shiftcrypto/firmware_v2:latest
make dockerdev
```


The docker container will not allow you to access the hosts USB devices by default which means that
it is necessary to flash the device in a terminal not running in docker.

> [!NOTE]
> Current development container is defined in the file `.containerversion`
The docker container mounts the repo it was launched from, so you can freely edit your fork in your preferred IDE and
the changes will be reflected in the docker container.

**It is highly recommended you develop using this docker container as not all of local setup is completely up to date
with every Operating system.**

### Install development environment on macOS

Make sure you have [Homebrew](https://brew.sh) installed.
Expand Down
3 changes: 3 additions & 0 deletions py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ To use the scripts (`send_message.py`, `load_firmware.py` for example) go into t
directory and run `pip3 install .`.

If you plan to work on the scripts run `pip3 install -e .` instead.

It is highly recommended that you use the dockerized setup while developing, guide for setting it up
can be found in [BUILD.md](../BUILD.md).
13 changes: 13 additions & 0 deletions py/bitbox02/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,16 @@ bitbox02.
In this folder is the Python API for communicating with the BitBox02 device.

The folder `generated` contains files generated by `python-protobuf`. Regenerate with `make`.


### Development environment

It is highly recommended that you use the dockerized setup while developing, guide for setting it up
can be found in [BUILD.md](../../BUILD.md).

If you intended to develop instead on your local environment be vary that some development procedures
such as regenerating files have their libraries NOT in requirements.txt as they are not necessary for the bitbox02
Python package.

It is highly advisable to use same version that is used in the [Dockerfile](../../Dockerfile) that is used in dockerized
setup.

0 comments on commit 89805cd

Please sign in to comment.