olliw42 / mLRS-docu

Documentation for the mLRS project
GNU General Public License v3.0
34 stars 11 forks source link

track some #79

Closed olliw42 closed 1 year ago

olliw42 commented 1 year ago

list may grow/shrink some are just ideas

out of sync:

none

ideas:

further:

olliw42 commented 1 year ago

@jlpoltrack just to confirm, you don't see any reasons why FLRC shouldn't be included in main, right? I.e. works for you?

jlpoltrack commented 1 year ago

@jlpoltrack just to confirm, you don't see any reasons why FLRC shouldn't be included in main, right? I.e. works for you?

No concerns from me.

olliw42 commented 1 year ago

great. So we'll make it permanent :) THX!!

jlpoltrack commented 1 year ago

@olliw42 @rotorman Could you give some hints on how this PR works if we want to document generically? https://github.com/olliw42/mLRS/pull/111

I went through the diff and I see this line added twice:

value="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.compiler.option.optimization.level.value.os" valueType="enumerated"

But don't really understand what this does. For example, would one only need to add these lines to any .cproject file to enable debug? Thanks

olliw42 commented 1 year ago

I think the procedure is NOT to directly fumble in this file, but to use the IDE's dialogs to enter the information. This might not be accurate, but like steps in chapters III & IV & A1 here https://github.com/olliw42/mLRS/blob/main/mLRS/CREATE_TARGET_INSTRUCTIONS.md#iii-create-target-ide-config, just for Debug

olliw42 commented 1 year ago

I guess what one needs to do is

step 10. click Debug step 12. follow exactly step 13. follow exactly step 16. follow exactly

if usb is needed

step A1.2 follow exactly

you guys may want to check

EDIT: did check and confirmed to be correct, see below

jlpoltrack commented 1 year ago

Would it make more sense to add the debug steps to that page itself? Then we could just link to it from the Docs / Custom Targets Page?

olliw42 commented 1 year ago

well, it would make the install more complicated than it is already ' I think not everyone will want debug, I actually think only few will.

rotorman commented 1 year ago

@olliw42 @rotorman Could you give some hints on how this PR works if we want to document generically?

Indeed, I would also suggest to use STM32CubeIDE dialogs for this. Basically, presently the release configuration has all the necessary include paths correctly set, whereas some have not yet been added into debug configuration. The task to get debug going is matching/adding the missing parts (e.g. by just comparing the dialogs and copy/pasting the missing ones).

olliw42 commented 1 year ago

I just tested it for a rx and a tx target, and can confirm that, when a Relase target was created, the steps

setp 10. click Debug step 12. follow exactly step 13. follow exactly step 16. follow exactly

and if usb is needed

step A1.2 follow exactly

make it to compile. If it is working I can't tell, but it compiles succesfully.

There are few vtable erros currently, which I will correct ASAP.

jlpoltrack commented 1 year ago

@olliw42 Would image like this be sufficient for initial flashing diagram? I thought about adding in ST-Link hardware but there are many variations and I think wouldn't want to recommend the cheap ones.

image

olliw42 commented 1 year ago

I would leave that totally you. I guess I would add a cheapo STLink just for the sake of teh picture looking more complete, but I think a diagram like yours is equally useful. Pl decide according to your taste :)

olliw42 commented 1 year ago

all done I guess :) so closing