Submodule kernel directory. (#16)

* Removing FreeRTOS/Source in readiness for submoduling.

* Submoduling kernel.

* README.md update due to submoduling.

When releasing, please follow these steps:
1. in local directory, clean directory and check "git status" shows "nothing to commit, working tree clean" for ALL subdirectories.
2. copy source code and instructions only to an empty folder. Git related should not be in this folder -- this covers .git, .gitignore, .github, .gitmodules, gitmessages, ......
3. zip the folder from step 2. (create both .zip and .7z)
4. attach .zip and .7z to the release. (e.g. attach these two in new release -- https://github.com/FreeRTOS/FreeRTOS/releases/new)
5. PLEASE download both, unzip, diff with your local git repo. (should not see any difference other than git related.) And, sanity check a couple of projects.
This commit is contained in:
Yuhui.Zheng 2020-02-14 12:47:01 -08:00 committed by GitHub
parent c3f8b91652
commit 24c772d143
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
518 changed files with 18 additions and 183006 deletions

View file

@ -23,11 +23,23 @@ The [FreeRTOS-Plus/Source](https://github.com/FreeRTOS/FreeRTOS/tree/master/Free
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.
Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
To clone using HTTPS:
```
git clone https://github.com/FreeRTOS/FreeRTOS.git
git clone https://github.com/FreeRTOS/FreeRTOS.git --recurse-submodules
```
Using SSH:
```
git clone git@github.com:FreeRTOS/FreeRTOS.git
git clone git@github.com:FreeRTOS/FreeRTOS.git --recurse-submodules
```
If you have downloaded the repo without using the `--recurse-submodules` argument, you need to run:
```
git submodule update --init --recursive
```
## Getting released versions
Working snapshots of released versions could be downloaded under [releases](https://github.com/FreeRTOS/FreeRTOS/releases).