Making examples easier to find

RogerClark
Thu May 12, 2016 9:53 pm
Hi Guys,

We have examples in the repo, but I think hardly anyone knows they are there

The IDE’s “Examples” menu, only seems to look in the Libraries folder.

So….

I know this is a hack, but I think one way to make the examples easy for people to find is to add a dummy library called “A_STM32_Examples”

This just needs a header in it, called A_STM32_Examples.h and a subfolder called examples

Then the IDE finds this “library” and puts it at the top of the examples list

examples.png
examples.png (65.29 KiB) Viewed 695 times

WereCatf
Thu May 12, 2016 10:43 pm
I, for one, like that approach.

RogerClark
Thu May 12, 2016 10:55 pm
@Warecatf

Thanks.


Kenjutsu
Fri May 13, 2016 3:37 am
WereCatf wrote:I, for one, like that approach.

RogerClark
Fri May 13, 2016 4:50 am
Thanks guys

I’m going to make the executive decision and make the change now, as we have me + 2 votes for the change and none against, and no other comments in the last 7 hours.


zoomx
Fri May 13, 2016 9:48 am
+3 (I cheated! :lol: )

martinayotte
Fri May 13, 2016 12:12 pm
+1

zmemw16
Fri May 13, 2016 2:41 pm
+1
+1 for like button
srp

Vassilis
Fri May 13, 2016 6:07 pm
+1 ;)

ahull
Fri May 13, 2016 6:34 pm
Image

WereCatf
Fri May 13, 2016 7:20 pm
Image

RogerClark
Fri May 13, 2016 9:18 pm
OK

All the changes, including the Examples have now been pushed to both the master and the development branch.

If anyone has any examples that want to add, you can zip and attach the source here and I’ll add them

One other thing we could do is add need sections to the examples or re-organise if necessary

e.g. we have examples from leaflabs under the maple folder, but this isn’t ideal.

Also BTW. I think we should remove the duplicate ILI9341 libs, as although it was handy to have a record of the different versions of that lib e.g. the Due version, I think its confusing and we should just have 1 lib that works well for this


zmemw16
Fri May 13, 2016 10:01 pm
RogerClark wrote:
Also BTW. I think we should remove the duplicate ILI9341 libs, as although it was handy to have a record of the different versions of that lib e.g. the Due version, I think its confusing and we should just have 1 lib that works well for this

RogerClark
Sat May 14, 2016 10:13 pm
I also noticed that some examples only work for the F1 as the #ifdef s are for __STM32F1__

I suspect they would work with the F4 and GD32F1, so I need to either add STMF4 and GD32F1 to the ifdefs or do it a different way

(mainly because I want to use the code on my GD32 boards)


Leave a Reply

Your email address will not be published. Required fields are marked *