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/19 19:57:56 UTC
[PR] readme: Updating README [nuttx]
fdcavalcanti opened a new pull request, #10980:
URL: https://github.com/apache/nuttx/pull/10980
[IN PROGRESS]
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.
--
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: [PR] readme: Updating README [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1777901299
> > @fdcavalcanti should we move the original README.md to the related documentation section?
>
> @xiaoxiang781216 Do you mean something like `nuttx/Documentation/legacy_README.md`? Maybe an actual page?
Yes, a new page or exist page
> I mean, its all versioned anyway. Not sure what is available on the README that can't be found on the actual documentation.
I don't think so, could you point out Documentation which contain the similar information in README.md?
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367943019
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
Review Comment:
I really can't see why we would need it, except for another badge to make it look "modern"
--
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: [PR] readme: Updating README [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1777684348
@fdcavalcanti should we move the original README.md to the related documentation section?
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1783757176
This PR introduced new warnings to the doc build:
```
/home/raiden00/git/RTOS/nuttx/nuttx/Documentation/legacy_README.md:684: WARNING: duplicate label introduction/resources:installation, other instance in /home/raiden00/git/RTOS/nuttx/nuttx/Documentation/introduction/resources.rst
/home/raiden00/git/RTOS/nuttx/nuttx/Documentation/legacy_README.md:684: WARNING: duplicate label legacy_readme:installation, other instance in /home/raiden00/git/RTOS/nuttx/nuttx/Documentation/legacy_README.md
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/raiden00/git/RTOS/nuttx/nuttx/Documentation/legacy_README.md: WARNING: document isn't included in any toctree
```
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367931217
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
Review Comment:
Do we need `Documentation Build Badge` ?
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1366951813
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
-# INTRODUCTION
-Apache NuttX is a real-time operating system (RTOS) with an emphasis on
-standards compliance and small footprint. Scalable from 8-bit to 64-bit
-microcontroller environments, the primary governing standards in NuttX are
-POSIX and ANSI standards. Additional standard APIs from Unix and other
-common RTOSs (such as VxWorks) are adopted for functionality not available
-under these standards, or for functionality that is not appropriate for
-deeply-embedded environments (such as fork()).
+Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
-Extensive documentation can be found on the project wiki:
- <https://cwiki.apache.org/NUTTX/NuttX>
+For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.
-For brevity, many parts of the documentation will refer to Apache NuttX as
-simply NuttX.
+## Getting Started
+First time on NuttX? Read the [Getting Started](https://nuttx.apache.org/docs/latest/quickstart/index.html) guide!
+If you don't have a board available, NuttX has its own simulator that you can run on terminal.
-# COMMUNITY
+## Documentation
+You can find the current NuttX documentation on: https://nuttx.apache.org/docs/latest/
-Every volunteer project obtains its strength from the people involved in
-it. We invite you to participate as much or as little as you choose.
+Alternatively, you can build the documentation yourself by following the Documentation Build [Instructions](https://nuttx.apache.org/docs/latest/contributing/documentation.html).
-We encourage you to:
+The old NuttX documentation is still available in the [Apache wiki](https://cwiki.apache.org/NUTTX/NuttX).
- - Use our project and provide feedback.
- - Provide us with use-cases.
- - Report bugs and submit patches.
- - Contribute code or documentation.
+## Supported Boards
+NuttX supports a wide variety of platforms. See the full list on the [Supported Platforms](https://nuttx.apache.org/docs/latest/introduction/supported_platforms.html) page.
Review Comment:
I think the only reliable source of supported platforms/boards is `boards/` directory. To be honest, this is the first time I see this subpage and I thought that the supported platforms where on https://nuttx.apache.org/docs/latest/platforms/index.html
So it turns out that we have supported platforms in 2 different places and neither of them is complete. What a mess :)
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367927924
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
-# INTRODUCTION
-Apache NuttX is a real-time operating system (RTOS) with an emphasis on
-standards compliance and small footprint. Scalable from 8-bit to 64-bit
-microcontroller environments, the primary governing standards in NuttX are
-POSIX and ANSI standards. Additional standard APIs from Unix and other
-common RTOSs (such as VxWorks) are adopted for functionality not available
-under these standards, or for functionality that is not appropriate for
-deeply-embedded environments (such as fork()).
+Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
-Extensive documentation can be found on the project wiki:
- <https://cwiki.apache.org/NUTTX/NuttX>
+For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.
-For brevity, many parts of the documentation will refer to Apache NuttX as
-simply NuttX.
+## Getting Started
+First time on NuttX? Read the [Getting Started](https://nuttx.apache.org/docs/latest/quickstart/index.html) guide!
+If you don't have a board available, NuttX has its own simulator that you can run on terminal.
-# COMMUNITY
+## Documentation
+You can find the current NuttX documentation on: https://nuttx.apache.org/docs/latest/
-Every volunteer project obtains its strength from the people involved in
-it. We invite you to participate as much or as little as you choose.
+Alternatively, you can build the documentation yourself by following the Documentation Build [Instructions](https://nuttx.apache.org/docs/latest/contributing/documentation.html).
-We encourage you to:
+The old NuttX documentation is still available in the [Apache wiki](https://cwiki.apache.org/NUTTX/NuttX).
- - Use our project and provide feedback.
- - Provide us with use-cases.
- - Report bugs and submit patches.
- - Contribute code or documentation.
+## Supported Boards
+NuttX supports a wide variety of platforms. See the full list on the [Supported Platforms](https://nuttx.apache.org/docs/latest/introduction/supported_platforms.html) page.
Review Comment:
https://nuttx.apache.org/docs/latest/introduction/supported_platforms.html has been removed in https://github.com/apache/nuttx/commit/88b7ce80a00d8c75beaa530ce1ca3611b02cd8b9 so please link to https://nuttx.apache.org/docs/latest/platforms/index.html
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1776223423
There's a chain icon on the NuttX logo appearing for me. Does anyone know why it's there? I can't see it on the PNG.
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1774132149
+1 for simplifying the readme. The big wall of text is not inviting for new users.
If we change `nuttx/readme` then `nuttx-apps/readme` should also be changed to a similar look. But for nuttx-apps/readme I think not everything is in Documentation now
--
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: [PR] readme: Updating README [nuttx]
Posted by "simbit18 (via GitHub)" <gi...@apache.org>.
simbit18 commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1777179731
I think we can include a field about the license
for example:
```html
## License
The code in this repository is all under either the Apache 2 license, or a
license compatible with the Apache 2 license. See the [LICENSE file](https://nuttx.apache.org/docs/latest/introduction/licensing.html) for more
information.
```
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367734142
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
-# INTRODUCTION
-Apache NuttX is a real-time operating system (RTOS) with an emphasis on
-standards compliance and small footprint. Scalable from 8-bit to 64-bit
-microcontroller environments, the primary governing standards in NuttX are
-POSIX and ANSI standards. Additional standard APIs from Unix and other
-common RTOSs (such as VxWorks) are adopted for functionality not available
-under these standards, or for functionality that is not appropriate for
-deeply-embedded environments (such as fork()).
+Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
-Extensive documentation can be found on the project wiki:
- <https://cwiki.apache.org/NUTTX/NuttX>
+For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.
-For brevity, many parts of the documentation will refer to Apache NuttX as
-simply NuttX.
+## Getting Started
+First time on NuttX? Read the [Getting Started](https://nuttx.apache.org/docs/latest/quickstart/index.html) guide!
+If you don't have a board available, NuttX has its own simulator that you can run on terminal.
-# COMMUNITY
+## Documentation
+You can find the current NuttX documentation on: https://nuttx.apache.org/docs/latest/
-Every volunteer project obtains its strength from the people involved in
-it. We invite you to participate as much or as little as you choose.
+Alternatively, you can build the documentation yourself by following the Documentation Build [Instructions](https://nuttx.apache.org/docs/latest/contributing/documentation.html).
-We encourage you to:
+The old NuttX documentation is still available in the [Apache wiki](https://cwiki.apache.org/NUTTX/NuttX).
- - Use our project and provide feedback.
- - Provide us with use-cases.
- - Report bugs and submit patches.
- - Contribute code or documentation.
+## Supported Boards
+NuttX supports a wide variety of platforms. See the full list on the [Supported Platforms](https://nuttx.apache.org/docs/latest/introduction/supported_platforms.html) page.
Review Comment:
Good catch. I think the documentation page could benefit from an update. Even upgrading the looks to something more modern could be done
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367928803
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
-# INTRODUCTION
-Apache NuttX is a real-time operating system (RTOS) with an emphasis on
-standards compliance and small footprint. Scalable from 8-bit to 64-bit
-microcontroller environments, the primary governing standards in NuttX are
-POSIX and ANSI standards. Additional standard APIs from Unix and other
-common RTOSs (such as VxWorks) are adopted for functionality not available
-under these standards, or for functionality that is not appropriate for
-deeply-embedded environments (such as fork()).
+Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
Review Comment:
could you stick to a maximum of 80 characters per line where possible ?
--
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: [PR] readme: Updating README [nuttx]
Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1374972127
##########
Documentation/introduction/resources.rst:
##########
@@ -20,3 +20,7 @@ Here's a list of Apache NuttX resources that you might find helpful:
* `Git Cheat Sheet (by GitHub) <https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf>`_
* `Git Book (online) <https://git-scm.com/book/en/v2>`_
+Legacy README
Review Comment:
@raiden00pl I think the issue is not because the file is too big, but because there is a Verbatim line too big:
"Dimension too large"
--
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: [PR] readme: Updating README [nuttx]
Posted by "simbit18 (via GitHub)" <gi...@apache.org>.
simbit18 commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1776764963
> There's a chain icon on the NuttX logo appearing for me. Does anyone know why it's there? I can't see it on the PNG.
@fdcavalcanti try with
`<p align="center">
<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
</p>`
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1777733999
> @fdcavalcanti should we move the original README.md to the related documentation section?
Do you mean something like `nuttx/Documentation/legacy_README.md`? Maybe an actual page?
I mean, its all versioned anyway. Not sure what is available on the README that can't be found on the actual documentation.
> I think we can include a field about the license for example:
>
> ```
> ## License
> The code in this repository is all under either the Apache 2 license, or a
> license compatible with the Apache 2 license. See the [LICENSE file](https://nuttx.apache.org/docs/latest/introduction/licensing.html) for more
> information.
> ```
I think we can improve this text. Maybe more details regarding other licenses that we see on menuconfig? Updated with this text for now.
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1780314301
Please check this new commit. Added the legacy README file to `Documentation/` and it is available in Introduction/Resources.
I'm not sure I like this format very much.. would appreciate some feedback.
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1370023592
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
Review Comment:
there is `[](https://github.com/apache/nuttx/releases)` but it doesn't seem to work with NuttX. Probably this works only with Github releases which is empty in our case https://github.com/apache/nuttx/releases
--
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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1372800713
##########
Documentation/introduction/resources.rst:
##########
@@ -20,3 +20,7 @@ Here's a list of Apache NuttX resources that you might find helpful:
* `Git Cheat Sheet (by GitHub) <https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf>`_
* `Git Book (online) <https://git-scm.com/book/en/v2>`_
+Legacy README
Review Comment:
Unfortunately this won't work. latexpdf fails when including large files. We can simply provide a link to the old README without including it.
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1375118343
##########
Documentation/introduction/resources.rst:
##########
@@ -20,3 +20,7 @@ Here's a list of Apache NuttX resources that you might find helpful:
* `Git Cheat Sheet (by GitHub) <https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf>`_
* `Git Book (online) <https://git-scm.com/book/en/v2>`_
+Legacy README
Review Comment:
That was Sphinx interpreting the `.md `file as a `.rst` file. It now includes properly.
It looks like this on PDF:
--
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: [PR] readme: Updating README [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 merged PR #10980:
URL: https://github.com/apache/nuttx/pull/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: [PR] readme: Updating README [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1367930512
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
Review Comment:
Other badge ideas: licence, link to release, link to doc
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on code in PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#discussion_r1369369601
##########
README.md:
##########
@@ -1,2530 +1,30 @@
-# APACHE NUTTX
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
+</h1><br>
-* Introduction
-* Community
- - Getting Help
- - Mailing Lists
- - Issue Tracker
- - Source Code
- - Website Source Code
-* Environments
- - Installing Cygwin
- - Ubuntu Bash under Windows 10
- - Using macOS
-* Installation
- - Download and Unpack
- - Semi-Optional apps/ Package
- - Installation Directories with Spaces in the Path
- - Downloading from Repositories
- - Related Repositories
- - Notes about Header Files
-* Configuring NuttX
- - Instantiating "Canned" Configurations
- - Refreshing Configurations
- - NuttX Configuration Tool
- - Finding Selections in the Configuration Menus
- - Reveal Hidden Configuration Options
- - Make Sure that You are on the Right Platform
- - Comparing Two Configurations
- - Making defconfig Files
- - Incompatibilities with Older Configurations
- - NuttX Configuration Tool under DOS
-* Toolchains
- - Cross-Development Toolchains
- - NuttX Buildroot Toolchain
-* Shells
-* Building NuttX
- - Building
- - Re-building
- - Build Targets and Options
- - Native Windows Build
- - Installing GNUWin32
-* Cygwin Build Problems
- - Strange Path Problems
- - Window Native Toolchain Issues
-* Documentation
+
+
+[](https://github.com/apache/nuttx/actions/workflows/build.yml)
+[](https://github.com/apache/nuttx/actions/workflows/doc.yml)
Review Comment:
I changed the "Build Documentation" badge to open the actual documentation.
Also added license. What would link to release be?
--
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: [PR] readme: Updating README [nuttx]
Posted by "fdcavalcanti (via GitHub)" <gi...@apache.org>.
fdcavalcanti commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1777023311
> > There's a chain icon on the NuttX logo appearing for me. Does anyone know why it's there? I can't see it on the PNG.
>
> @fdcavalcanti try with
>
> ```
> <p align="center">
> <img src="https://raw.githubusercontent.com/apache/nuttx/master/Documentation/_static/NuttX320.png" width="150">
> </p>
> ```
Thanks, it worked! Really starting to look good.
--
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: [PR] readme: Updating README [nuttx]
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on PR #10980:
URL: https://github.com/apache/nuttx/pull/10980#issuecomment-1780419643
> Please check this new commit. Added the legacy README file to `Documentation/` and it is available in Introduction/Resources. I'm not sure I like this format very much.. would appreciate some feedback.
it's better than remove the old readme directly at least.:).
--
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