search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.16k stars 6.23k forks source link

samples without README #27805

Open pabigot opened 3 years ago

pabigot commented 3 years ago

Taking #27130 to the next step: The following samples do not have a README:

pabigot commented 3 years ago 
find samples/ -name sample.yaml \
| sed -e 's@/[^/]*$@@' \
| while read dir ; do \
  if $(cd $dir && ls | grep -i '^readme' > /dev/null) ; then \
    :  ; \
  else  \
    echo '* [ ]' $dir ; \
   fi \
done \
| sort
KozhinovAlexander commented 3 years ago

I think Good First Issue would be good for the beginners.

kartben commented 1 year ago

I've updated the checklist in the initial comment with the current status. I've also made sure samples with a README that's not a README.rst are also listed

Spice-Weasel commented 9 months ago

I will document the lora samples

kartben commented 9 months ago

I will document the lora samples

Very nice, thanks!

kartben commented 9 months ago

@Spice-Weasel let me know if I can help with anything as you go through this. Thanks again!

Spice-Weasel commented 9 months ago

@kartben will do. I thought this was lorawan and not lora. 😅 I can document it anyway will try to find some time this weekend

kartben commented 7 months ago

Note to self (or to anyone else reading this and looking for inspiration of what samples might be of higher priority than others): adding the README to samples/subsys/shell/shell_module sooner ratherthan later would be really nice. It is quite a "key" sample for people interested in developing shell commands, and having some clarity on what the purpose of the sample is would be really useful. Some people have started to incorrectly use it as a place to dump overlays and config files that can be used to try all kinds of shell commands on a board, and that's not what this sample is for.

@Spice-Weasel no obligation whatsoever, of course, but in case you want to give it a shot, I will be around to help with reviewing :)

Spice-Weasel commented 7 months ago

@kartben thanks. I'll have a look at it!