diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-09-27 22:17:28 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-09-27 22:17:28 +0200 |
| commit | acd6ce94aec16860ee5c0b690707db4feb428f72 (patch) | |
| tree | dde886f78575951fcfd9a35494061b9527084ece | |
| parent | 7038e12c3e4ee4284495018546a88e98df891a00 (diff) | |
readme and install script shuffle
| -rw-r--r-- | readme.md | 19 | ||||
| -rwxr-xr-x | scripts/install-packages-arch.sh | 8 | ||||
| -rw-r--r-- | scripts/install-packages-brew.sh | 12 | ||||
| -rwxr-xr-x[-rw-r--r--] | scripts/install-packages-mingw.sh | 4 | ||||
| -rw-r--r-- | scripts/readme.md | 10 |
5 files changed, 44 insertions, 9 deletions
@@ -9,11 +9,18 @@ compilation. make sure to initialize and sync the git submodules, or re-clone using the `--recursive` flag. -## windows specific notes +## support -[link to windows toolchain installation](scripts/readme.md#windows-install) +this project is currently being developed and tested on the host platforms +listed below. toolchain installation scripts can be found in the +[scripts](scripts) subdirectory. + +||Arch Linux<br>(x86_64)|Windows 10<br>(x86_64)|MacOS Monterey<br>(arm/apple m1)| +|-|-|-|-| +|STM32 makefile compilation|yes|yes|?| +|STM32 makefile upload|yes|yes|?| +|STM32 debugging (vscode)|yes|yes|?| +|QT client compilation (qmake)|yes|?|?| +|QT client running|yes|?|?| +|QT client debugging (vscode)|?|?|?| -- if you're experiencing libusb-related issues while using st-link, - try using [zadig](https://zadig.akeo.ie/) to update the usb driver. -- make sure to use the 64-bit version of msys2 (titled "MSYS2 MINGW64" in your - start menu) diff --git a/scripts/install-packages-arch.sh b/scripts/install-packages-arch.sh new file mode 100755 index 0000000..6200f11 --- /dev/null +++ b/scripts/install-packages-arch.sh @@ -0,0 +1,8 @@ +#!/bin/sh +pacman --noconfirm --needed -Sy \ + make git \ + arm-none-eabi-gcc \ + arm-none-eabi-gdb \ + arm-none-eabi-newlib \ + arm-none-eabi-binutils \ + stlink diff --git a/scripts/install-packages-brew.sh b/scripts/install-packages-brew.sh new file mode 100644 index 0000000..f402048 --- /dev/null +++ b/scripts/install-packages-brew.sh @@ -0,0 +1,12 @@ +#!/bin/sh + +echo "this installation script is untested, press Ctrl+C to exit, or wait 5 seconds to continue..." +sleep 5 + +# TODO: missing arm-none-eabi-newlib (manual install?) + +brew install --cask \ + make git \ + gcc-arm-embedded \ + stlink + diff --git a/scripts/install-packages-mingw.sh b/scripts/install-packages-mingw.sh index aed48d9..112b96c 100644..100755 --- a/scripts/install-packages-mingw.sh +++ b/scripts/install-packages-mingw.sh @@ -1,5 +1,5 @@ #!/bin/sh -pacman --noconfirm -Sy \ +pacman --noconfirm --needed -Sy \ make git \ mingw-w64-x86_64-arm-none-eabi-gcc \ mingw-w64-x86_64-arm-none-eabi-gdb \ @@ -8,4 +8,4 @@ pacman --noconfirm -Sy \ mingw-w64-x86_64-stlink \ mingw-w64-x86_64-gdb-multiarch -printf "\n\n\ninstalling packages done!"
\ No newline at end of file +printf "\n\n\ninstalling packages done!" diff --git a/scripts/readme.md b/scripts/readme.md index 41742cf..4e568c0 100644 --- a/scripts/readme.md +++ b/scripts/readme.md @@ -1,6 +1,6 @@ # scripts -this subdirectory contains auxiliary scripts +this subdirectory contains build toolchain setup and other auxiliary scripts ## windows install @@ -19,3 +19,11 @@ done!" to appear. you've now installed the necessary tools to compile, upload and debug the stm32 firmware. shortcuts for commonly used commands are implemented as visual studio code tasks, so you don't have to be a terminal ninja. + +### notes + +- if you're experiencing libusb-related issues while using st-link, try using + [zadig](https://zadig.akeo.ie/) to update the usb driver. +- make sure to use the 64-bit version of msys2 (titled "MSYS2 MINGW64" in your + start menu) + |