summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Evans <715855+mmalex@users.noreply.github.com>2023-07-25 20:32:15 +0100
committerAlex Evans <715855+mmalex@users.noreply.github.com>2023-07-25 20:32:15 +0100
commit982b59c3136e44aaeef2de031677d80c95287cfa (patch)
treea4dd9d7ec90f474261f50c5f34f501671e1f8ac1
parentc898827d35ce71998fa70d165bbc249844ea962f (diff)
downloadplinky-982b59c3136e44aaeef2de031677d80c95287cfa.tar.gz
more build docs
-rw-r--r--.gitignore5
-rw-r--r--imgs/importdialog.pngbin0 -> 497163 bytes
-rw-r--r--imgs/macsarecrap1.pngbin0 -> 97261 bytes
-rw-r--r--imgs/macsarecrap2.pngbin0 -> 78855 bytes
-rw-r--r--imgs/project.pngbin0 -> 377040 bytes
-rw-r--r--raw_build_guide.md29
6 files changed, 33 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 7d0dd00..8bef224 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,8 @@ hw/WIP_inputfix/plinkyblack-backups
hw/WIP_inputfix/\#auto_saved_files\#
hw/WIP_inputfix/fp-info-cache
hw/WIP_inputfix/fp-info-cache
+
+bootloader/Release
+sw/Release
+bootloader/Debug
+sw/Debug \ No newline at end of file
diff --git a/imgs/importdialog.png b/imgs/importdialog.png
new file mode 100644
index 0000000..4106dae
--- /dev/null
+++ b/imgs/importdialog.png
Binary files differ
diff --git a/imgs/macsarecrap1.png b/imgs/macsarecrap1.png
new file mode 100644
index 0000000..e667661
--- /dev/null
+++ b/imgs/macsarecrap1.png
Binary files differ
diff --git a/imgs/macsarecrap2.png b/imgs/macsarecrap2.png
new file mode 100644
index 0000000..102067f
--- /dev/null
+++ b/imgs/macsarecrap2.png
Binary files differ
diff --git a/imgs/project.png b/imgs/project.png
new file mode 100644
index 0000000..8b8bef7
--- /dev/null
+++ b/imgs/project.png
Binary files differ
diff --git a/raw_build_guide.md b/raw_build_guide.md
index 47da87d..d69e7a2 100644
--- a/raw_build_guide.md
+++ b/raw_build_guide.md
@@ -14,7 +14,15 @@ The bin file is typically named `plink09z.bin` or similar, where the last 3 digi
The bin file can be placed onto the plinky using STM32CubeProgrammer, which is available for free from [ST here](https://www.st.com/en/development-tools/stm32cubeprog.html).
-At the time of writing, stm32cubeprog seems to have problems running on a mac. Even after allowing it to run in the Settings & Security part of the OSX control panel, it often hangs or fails to open entirely. you may need to use a PC, linux, wait for ST to fix it, or fight through various forum posts online.
+At the time of writing, stm32cubeprog seems to have problems running on a mac. The first time you run it, you will see:
+
+<img src="imgs/macsarecrap1.png" width="250">
+
+Even after allowing it to run in the Settings & Security part of the OSX control panel by clicking 'open anyway':
+
+<img src="imgs/macsarecrap2.png" width="350">
+
+it often hangs or fails to open entirely. I do not know why, and nor does the internet. you may need to use a PC, linux, wait for ST to fix it, or fight through various forum posts online, possibly installing outdated JREs and so forth. fun.
Assuming you have got it to run...
@@ -25,7 +33,26 @@ First, find the 'boot0' and nearby '3v3' pad on the back of plinky. you need to
* check out the github repo https://github.com/plinkysynth/plinky_public
* install a fresh install of STM32CubeIDE, available for free from [ST here](https://www.st.com/en/development-tools/stm32cubeide.html) for mac, windows and linux
* at the time of writing, the latest version is 1.13
+ * like STM32CubeProgrammer above, on a mac this will refuse to open the first time. see the discourse above for some tips. the good news is that once you click 'run anyway', it seems more stable than the programmer.
* you need python 3.x to be installed and working (check if you can run python from the commandline)
+
+On first boot, STM32CubeIDE, after choosing a workspace folder, should present you with a welcome screen that allows you to 'import a project'. Do so, giving this confusing dialog:
+
+<img src="imgs/importdialog.png">
+
+Click 'directory...' and select the directory that is the root of your git checkout. This should then show you 3 projects with checks - the first being the folder as a whole, the second being the 'sw' project (main plinky firmware), and the third being the 'bootloader' project. Make sure the latter two are checked; uncheck the root folder. click ok.
+
+You should see something like this:
+
+<img src="imgs/project.png">
+
+Right click on each of the projects on the left panel, and in the context menu select 'Build Configurations' / 'Set Active' / 'Release'.
+
+Now go to the app's 'Project' menu and select 'Build All'.
+
+
+
+
* more steps TODO
## booting a raw plinky for the first time