Skip to content

Commit

Permalink
Readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
shermp committed Aug 27, 2024
1 parent a28c25f commit fad4ae9
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,15 @@ Pico-ASHA is an attempt to implement Android's Audio Streaming for Hearing Aids

## How to test/develop

### Compile
### Precompiled builds for testing

Any commits pushed to this repository compiles an ELF and UF2 binary that can be loaded onto a Pico W.

Both UART and USB serial binaries are compiled, you can choose whichever is most suitable for you.

Binaries are available for download from the Github Actions tab. You mist be logged into Github to download these binaries.

### Compile for dev/testing

Download [pico-sdk](https://github.com/raspberrypi/pico-sdk) 1.5.1, using the provided instructions.

Expand All @@ -32,7 +40,13 @@ cmake -DCMAKE_BUILD_TYPE=MinSizeRel ..
cmake --build .
```

To load the program onto your Pico W, press the `BOOTSEL` button while plugging it into the PC over USB. Then copy the `asha.uf2` onto the mass storage device.
### Installing

To load the program onto your Pico W, press the `BOOTSEL` button while plugging it into the PC over USB. Then copy the `pico-asha.uf2` onto the mass storage device.

Developers with a suitable debug (SWD) connection to the Pico may alternatively load `pico-asha.elf` using OpenOCD. This provides a non-interactive method of loading Pico-ASHA without having to press the `BOOTSEL` button.

Instructions for doing so are outside the scope of this readme.

### Serial

Expand All @@ -47,10 +61,6 @@ Alternatively, Pico-ASHA can log output via USB serial using the standard Raspbe

Pass `-DENABLE_USB_SERIAL=ON` to cmake during configure to enable USB serial.

### Reloading program

It is possbile to load new versions of the software without having to press the `BOOTSEL` button. If you have a SWD connection setup (by using a debug probe), you can use OpenOCD to upload new firmware.

## Licence

Unless otherwise noted in the file, the source code in this repository is licenced under the BSD 3-clause licence, however any binaries must be provided on a more restrictive licence, see below.
Expand Down

0 comments on commit fad4ae9

Please sign in to comment.