[GitHub] [incubator-nuttx-apps] v01d commented on a change in pull request #337: Use Markdown for readmes

[GitBox <gi...@apache.org>]

v01d commented on a change in pull request #337:
URL: https://github.com/apache/incubator-nuttx-apps/pull/337#discussion_r458857121



##########
File path: README.md
##########
@@ -0,0 +1,241 @@
+# Application Folder
+
+## Contents
+
+- General
+- Directory Location
+- Built-In Applications
+- NuttShell (NSH) Built-In Commands
+- Synchronous Built-In Commands
+- Application Configuration File
+- Example Built-In Application
+- Building NuttX with Board-Specific Pieces Outside the Source Tree
+
+## General
+
+This folder provides various applications found in sub-directories. These
+applications are not inherently a part of NuttX but are provided to help
+you develop your own applications. The `apps/` directory is a _break away_
+part of the configuration that you may choose to use or not.
+
+## Directory Location
+
+The default application directory used by the NuttX build should be named
+`apps/` (or `apps-x.y.z/` where `x.y.z` is the NuttX version number). This `apps/`
+directory should appear in the directory tree at the same level as the
+NuttX directory. Like:
+
+```
+ .
+ |- nuttx
+ |
+ `- apps

Review comment:
       It is easier and simpler to just prepend these kind of verbatim blocks with four spaces. The backticks are not required (unless you need to escape something I think)




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org