search

stefanrueger / urboot

Small AVR bootloader using urprotocol
GNU General Public License v3.0
55 stars 8 forks source link

More documentations #16

Closed mcuee closed 1 year ago

mcuee commented 1 year ago

I think the current documentation is already pretty good. But it is still good to add more.

1) What is urboot -- README.md

2) urprotocol -- urprotocol.md

3) How to choose urboot bootloader options -- -- howtoselect.md

4) Compiling urboot -- more details to be added, some simple explanations about the usage of urboot-gcc and hexls would be nice.

5) How urboot works -- I am not so sure if something like the following is good to have or not. https://github.com/Optiboot/optiboot/wiki/HowOptibootWorks

6) FAQ -- to be added (initially it may be empty but more can be added)

stefanrueger commented 1 year ago

@mcuee Gave it a shot. I think that now the documentation is as good as it gets.

mcuee commented 1 year ago

@mcuee Gave it a shot. I think that now the documentation is as good as it gets.

Thanks. Now it seems to be pretty comprehensive from a quick glance.

The only missing thing is to mention MH Tiny in https://github.com/stefanrueger/urboot/blob/main/README.md

stefanrueger commented 1 year ago

| The only missing thing is to mention

Well there are tons of other boards in the boards directory that are not mentioned. We have to draw a line with the examples somewhere :smile:

mcuee commented 1 year ago

No issues. I understand.