Skip to content

Commit 3fd8cf4

Browse files
committed
README.md: Remove coroutine references.
1 parent b16319d commit 3fd8cf4

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Getting started
2-
This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository, which contains pre-configured demo application projects under ```FreeRTOS/Demo``` directory.
2+
This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository, which contains pre-configured demo application projects under ```FreeRTOS/Demo``` directory.
33

44
The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects. That way you will have the correct FreeRTOS source files included, and the correct include paths configured. Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files. See the [FreeRTOS Kernel Quick Start Guide](https://www.FreeRTOS.org/FreeRTOS-quick-start-guide.html) for detailed instructions and other useful links.
55

@@ -66,19 +66,18 @@ git clone [email protected]:FreeRTOS/FreeRTOS-Kernel.git
6666
```
6767

6868
## Repository structure
69-
- The root of this repository contains the three files that are common to
70-
every port - list.c, queue.c and tasks.c. The kernel is contained within these
71-
three files. croutine.c implements the optional co-routine functionality - which
72-
is normally only used on very memory limited systems.
69+
- The root of this repository contains the three files that are common to
70+
every port - list.c, queue.c and tasks.c. The kernel is contained within these
71+
three files.
7372

74-
- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
73+
- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
7574
See the readme file in the ```./portable``` directory for more information.
7675

7776
- The ```./include``` directory contains the real time kernel header files.
7877

7978
### Code Formatting
80-
FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/main/tools/uncrustify.cfg).
79+
FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/main/tools/uncrustify.cfg).
8180

8281
### Spelling
83-
*lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to *lexicon.txt*.
82+
*lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to *lexicon.txt*.
8483
Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.

0 commit comments

Comments
 (0)