github-forks
/
FreeRTOS
mirror of https://github.com/FreeRTOS/FreeRTOS.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updates to Markdown files and readme.txt (#11)

Browse Source
pull/13/head
Cobus van Eeden 5 years ago committed by GitHub
parent 4b53196b71
commit 84fcc0d531
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 58 additions and 8 deletions
Show Stats Download Patch File Download Diff File

16
CONTRIBUTING.md
Unescape Escape View File

@ -9,11 +9,13 @@ information to effectively respond to your bug report or contribution.
## Reporting Bugs/Feature Requests ## Reporting Bugs/Feature Requests
We welcome you to use the GitHub issue tracker to report bugs or suggest features. We recommend using the [FreeRTOS support forum](https://forums.freertos.org/) to discuss and clarify issues before raising a GitHub issue in this repository.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already Once it has been discussed we welcome you to use the GitHub issue tracker to report bugs or suggest features.
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
When filing an issue, please check discussions on the support forum, existing open and recently closed issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
* A clear description of the expected behavior, what you are observing instead and how it differs from what you observe.
* A reproducible test case or series of steps * A reproducible test case or series of steps
* The version of our code being used * The version of our code being used
* Any modifications you've made relevant to the bug * Any modifications you've made relevant to the bug
@ -31,8 +33,7 @@ To send us a pull request, please:
1. Fork the repository. 1. Fork the repository.
1. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. 1. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
1. Make sure to follow the coding style guide. 1. Make sure to follow the [coding style guide](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).
1. Ensure local tests pass.
1. Commit to your fork using clear commit messages. 1. Commit to your fork using clear commit messages.
1. Send us a pull request, answering any default questions in the pull request interface. 1. Send us a pull request, answering any default questions in the pull request interface.
NOTE: Please make sure the default option (Allow edits from maintainers) is left checked. NOTE: Please make sure the default option (Allow edits from maintainers) is left checked.
@ -42,7 +43,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
## Coding Style ## Coding Style
* Please ensure that your code complies to the FreeRTOS coding style guidelines, https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html * Please ensure that your code complies to the [FreeRTOS coding style guidelines](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html)
## Getting Your Pull Request Merged ## Getting Your Pull Request Merged
@ -64,7 +65,8 @@ If you discover a potential security issue in this project we ask that you notif
## Licensing ## Licensing
The FreeRTOS kernel is released under the MIT open source license, the text of which can be found [here](https://github.com/FreeRTOS/FreeRTOS/blob/master/FreeRTOS/License/license.txt)
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution. Additional license files can be found in the folders containing any supplementary libraries licensed by their respective copyright owners where applicable.
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

48
README.md
Unescape Escape View File

@ -0,0 +1,48 @@
## Getting Started
The easiest way to use FreeRTOS is to start with one of the pre-configured demo
application projects (found in the FreeRTOS/Demo directory). 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.
Additionally, for FreeRTOS kernel feature information refer to the [Developer Documentation](https://www.freertos.org/features.html), and [API Reference](https://www.freertos.org/a00106.html).
### Getting Help
If you have any questions or issues, then we provide our community responsive active assistance on [FreeRTOS 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 refactoring 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
To clone using HTTPS:
```
git clone https://github.com/FreeRTOS/FreeRTOS
```
Using SSH:
```
git clone https://github.com/FreeRTOS/FreeRTOS.git
```

2
readme.txt
Unescape Escape View File

@ -18,7 +18,7 @@ Directories:
FreeRTOS windows simulator. These are documented on the FreeRTOS web site FreeRTOS windows simulator. These are documented on the FreeRTOS web site
http://www.FreeRTOS.org/plus http://www.FreeRTOS.org/plus
Further readme files are contains in sub-directories as appropriate. Further readme files are contained in sub-directories as appropriate.
The easiest way to use FreeRTOS is to start with one of the pre-configured demo The easiest way to use FreeRTOS is to start with one of the pre-configured demo
application projects (found in the FreeRTOS/Demo directory). That way you will application projects (found in the FreeRTOS/Demo directory). That way you will

Write Preview
Loading…
Cancel
Save