Skip to content

Commit

Permalink
Merge pull request #97 from mossmann/readme
Browse files Browse the repository at this point in the history
Fix README
  • Loading branch information
mossmann authored Jul 5, 2024
2 parents c528993 + aa57551 commit 0ca6bbe
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,16 @@ Apollo is the on-board debugger and programmer on [Cynthion](https://greatscottg

Apollo consists of two main parts: firmware for the on-board debug microcontroller and Python-based software for the host computer.

## Installing Host Software

To install the apollo-fpga Python module and the `apollo` command-line tool or to upgrade them to the latest version run:
```
pip install --upgrade apollo-fpga
```

## Building and Installing Firmware

To upgrade Apollo firmware on a Cynthion it is typically not necessary to compile the firmware yourself. Instead follow [Upgrading Cynthion Device Firmware])https://cynthion.readthedocs.io/en/latest/getting_started.html#upgrading-cynthion-device-firmware).
To upgrade Apollo firmware on a Cynthion it is typically not necessary to compile the firmware yourself. Instead follow [Upgrading Cynthion Device Firmware](https://cynthion.readthedocs.io/en/latest/getting_started.html#upgrading-cynthion-device-firmware).

To compile and install onto Cynthion run:

Expand All @@ -25,10 +32,3 @@ $ make APOLLO_BOARD=cynthion BOARD_REVISION_MAJOR=0 BOARD_REVISION_MINOR=3 get-d
```

Once installation is complete, LED A should activate, indicating that Apollo is running.

## Installing Host Software

To install the apollo-fpga Python module and the `apollo` command-line tool or to upgrade them to the latest version run:
```
pip install --upgrade apollo-fpga
```

0 comments on commit 0ca6bbe

Please sign in to comment.