You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "fdcavalcanti (via GitHub)" <gi...@apache.org> on 2023/10/13 13:38:42 UTC
[I] Github README Improvement [nuttx]
fdcavalcanti opened a new issue, #10906:
URL: https://github.com/apache/nuttx/issues/10906
Hi everyone!
I would like to propose a new README page on Github. The current one is a big wall of text which is already covered in the documentation.
I think we can do something smaller and cleaner just by following some examples online.
Sure, it's a visual thing but I personally think this can help attract more people and gives a "cleaner" look!
Here's what I propose, following these repos as reference: [link 1](https://github.com/zephyrproject-rtos/zephyr), [link 2](https://github.com/pytest-dev/pytest), [link 3](https://github.com/numpy/numpy)
- Put the NuttX logo on top
- Add badges showing status of build, docs, version, etc
- Quick intro to what NuttX is
- Topics on contributing, documentation and getting started
I would love to hear some more ideas from the community, please feel free to add them here.
Filipe
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Github README Improvement [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 closed issue #10906: Github README Improvement
URL: https://github.com/apache/nuttx/issues/10906
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Github README Improvement [nuttx]
Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on issue #10906:
URL: https://github.com/apache/nuttx/issues/10906#issuecomment-1761585472
I think this is a good suggestion!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Github README Improvement [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on issue #10906:
URL: https://github.com/apache/nuttx/issues/10906#issuecomment-1771627723
See #10980
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Github README Improvement [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on issue #10906:
URL: https://github.com/apache/nuttx/issues/10906#issuecomment-1769109093
@fdcavalcanti could you send your patch for review?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Github README Improvement [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on issue #10906:
URL: https://github.com/apache/nuttx/issues/10906#issuecomment-1765465767
I've created a sample on my fork: [link](https://github.com/fdcavalcanti/nuttx/tree/new-readme)
We can add more badges, improve the logo, wherever is necessary.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org