diff --git a/configs/README.txt b/configs/README.txt index a555757cf60..c8a6e01c78a 100644 --- a/configs/README.txt +++ b/configs/README.txt @@ -1,5 +1,18 @@ Board-Specific Configurations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This directory contains the board support for logic for all boards supported +by NuttX. This directory is retained in a separate repository and is a Sub- +Module of NuttX and will appear as nuttx/configs when the NuttX repository +is cloned. + +The nuttx/configs directory is a part of the internal OS. It there should +contain only OS bring-up logic and driver initialization logic. THERE SHOUL + BE NO APPLICATION CALLABLE LOGIC IN THIS DIRECTORY. + +If you have board-specific, application callable logic, that logic should not +go here. Please consider using a sub-directory under apps/platform instead. + Table of Contents ^^^^^^^^^^^^^^^^^