From 42c627b2b88cb3b487fea983d8b566a8bbae54fa Mon Sep 17 00:00:00 2001 From: "Yuhui.Zheng" <10982575+yuhui-zheng@users.noreply.github.com> Date: Fri, 6 Mar 2020 09:15:11 -0800 Subject: [PATCH] Update readme and revert relative URL. (#27) * Reordering: bumping cloning instruction up. * Rewording readme.md to be clear kernel code is a submodule of this repository. * Reverting relative URL, since user cannot click through on GitHub page. (With URL, user could still download the correct version of the code. Reverting simply due to UI issue.) --- .gitmodules | 2 +- README.md | 32 ++++++++++++++++---------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.gitmodules b/.gitmodules index c77776f4d2..7977ee14be 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "FreeRTOS/Source"] path = FreeRTOS/Source - url = ../FreeRTOS-Kernel.git + url = https://github.com/FreeRTOS/FreeRTOS-Kernel.git diff --git a/README.md b/README.md index 01a78000c9..4634af9c74 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,6 @@ Additionally, for FreeRTOS kernel feature information refer to the [Developer Do ### Getting help If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). -## Repository structure -This repository contains the FreeRTOS Kernel, a number of supplementary libraries, and a comprehensive set of example applications. - -### Kernel sources -The FreeRTOS Kernel Source is located under [FreeRTOS/Source](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS/Source) - -Hardware specific ports can be found under [FreeRTOS/Source/portable](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS/Source/portable) - -A number of Demo projects can be found under [FreeRTOS/Demo](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS/Demo) - -### Supplementary library sources -The [FreeRTOS-Plus/Source](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Plus/Source) directory contains source code for some of the FreeRTOS+ components, as well as select partner provided libraries. These subdirectories contain further readme files and links to documentation. - -[FreeRTOS-Labs](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Labs) contains libraries and demos that are fully functional, but undergoing optimizations or refactorization to improve memory usage, modularity, -documentation, demo usability, or test coverage. At this time the projects ARE A WORK IN PROGRESS and will be released in the main FreeRTOS directories of the download following full review and completion of the documentation. - ## Cloning this repository This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components. @@ -41,5 +25,21 @@ If you have downloaded the repo without using the `--recurse-submodules` argumen git submodule update --init --recursive ``` +## Repository structure +This repository contains the FreeRTOS Kernel, a number of supplementary libraries, and a comprehensive set of example applications. + +### Kernel sources +The FreeRTOS Kernel Source is in [FreeRTOS/FreeRTOS-Kernel repository](https://github.com/FreeRTOS/FreeRTOS-Kernel), and it is consumed as a submodule in this repository. + +The version of the FreeRTOS Kernel Source in use could be accessed at [```./FreeRTOS/Source```](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS/Source) + +A number of Demo projects can be found under [```./FreeRTOS/Demo```](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS/Demo) + +### Supplementary library sources +The [FreeRTOS-Plus/Source](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Plus/Source) directory contains source code for some of the FreeRTOS+ components, as well as select partner provided libraries. These subdirectories contain further readme files and links to documentation. + +[FreeRTOS-Labs](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Labs) contains libraries and demos that are fully functional, but undergoing optimizations or refactorization to improve memory usage, modularity, +documentation, demo usability, or test coverage. At this time the projects ARE A WORK IN PROGRESS and will be released in the main FreeRTOS directories of the download following full review and completion of the documentation. + ## Previous releases Previous releases are available for download under [releases](https://github.com/FreeRTOS/FreeRTOS/releases). \ No newline at end of file