search

fossasia / pslab-firmware

Firmware for PSLab Open Hardware Platform https://pslab.io
Apache License 2.0
1.56k stars 76 forks source link

Prepare for repository split #133

Closed bessman closed 2 years ago

bessman commented 2 years ago

This PR is in preparation for splitting the bootloader out of this repository into fossasia/pslab-bootloader. After this is merged, I will make another PR to delete the bootloader directory and move contents of the firmware directory up one level to the repository root.

I also made some minor updates to the README.

Side note, but what it the purpose of FirmwareFlowChart.drawio? I understand that it can be opened in draw.io to view a flowchart of the firmware, but it seems way too big to be useful? I have a pretty decent computer, but the draw.io view is unusably slow for me when opening the flowchart. It also doesn't update automatically when changes are made to the source code, so it will inevitably become outdated, if it isn't already. I could see something like that being useful as part of the documentation (though probably in smaller pieces), but I question the usefulness of version controlling it in the main firmware repo. I would like to delete it.

bessman commented 2 years ago

Codacy is unhappy about the code, but since I haven't actually touched the code in this PR I'm not going to fix it right now.