Skip to content

Commit ee8aec3

Browse files
author
camilo
committed
remove codeql, update readme and update doc stylesheet
1 parent b2020cd commit ee8aec3

File tree

4 files changed

+5
-137
lines changed

4 files changed

+5
-137
lines changed

.github/workflows/codeql-buildscript.sh

Lines changed: 0 additions & 4 deletions
This file was deleted.

.github/workflows/codeql.yml

Lines changed: 0 additions & 126 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@
1212
[![CERT](https://img.shields.io/badge/CERT-Compliant-blue.svg?logo=c)](https://wiki.sei.cmu.edu/confluence/display/seccode/SEI+CERT+Coding+Standards)
1313
[![C Standard](https://img.shields.io/badge/STD-C99-green.svg?logo=c)](https://en.wikipedia.org/wiki/C99)
1414
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?logo=textpattern)](https://github.com/TECREA/QuarkTS/graphs/commit-activity)
15-
[![CodeQL](https://github.com/kmilo17pet/QuarkTS/actions/workflows/codeql.yml/badge.svg)](https://github.com/kmilo17pet/QuarkTS/actions/workflows/codeql.yml)
1615
[![License](https://img.shields.io/github/license/TECREA/QuarkTS?logo=livejournal)](https://github.com/TECREA/QuarkTS/blob/master/LICENSE) [![Join the chat at https://gitter.im/embedded-c/QuarkTS-OS](https://badges.gitter.im/embedded-c/QuarkTS-OS.svg)](https://gitter.im/embedded-c/QuarkTS-OS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
17-
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fkmilo17pet%2FQuarkTS&count_bg=%2379C83D&title_bg=%23555555&icon=cliqz.svg&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://github.com/kmilo17pet/QuarkTS)
1816

1917
![Logo](https://github.com/kmilo17pet/QuarkTS/blob/master/doc/quarktslogo.png)
2018

@@ -33,21 +31,21 @@ QuarkTS is an operating system that provides a modern environment to build stabl
3331
- Co-routines.
3432
- AT Command Line Interface (CLI)
3533

36-
QuarkTS is developed using a formal and rigorous process framed in compliance with the MISRA C 2012 and CERT coding standard guidelines and complemented with multiple static-analysis checks targeted to safe critical applications.
34+
QuarkTS is developed using a formal and rigorous process framed in compliance with the MISRA C 2012 and CERT coding standard guidelines and complemented with multiple static-analysis checks targeted to safe critical applications.
3735

3836
### Why cooperative?
3937

40-
Rather than having preemption, tasks manage their own life-cycle. This brings significant benefits, fewer re-entrance problems are encountered, because tasks cannot be interrupted arbitrarily by other tasks, but only at positions permitted by the programmer, so you mostly do not need to worry about pitfalls of the concurrent approach (resource-sharing, race-conditions, deadlocks, etc...).
38+
Rather than having preemption, tasks manage their own life-cycle. This brings significant benefits, fewer re-entrance problems are encountered, because tasks cannot be interrupted arbitrarily by other tasks, but only at positions permitted by the programmer, so you mostly do not need to worry about pitfalls of the concurrent approach (resource-sharing, race-conditions, deadlocks, etc...).
4139

4240
### What is it made for?
4341

4442
The design goal of QuarkTS is to achieve its stated functionality using a small, simple, and (most importantly) robust implementation to make it suitable on resource-constrained microcontrollers, where a full-preemptive RTOS is an overkill and their inclusion adds unnecessary complexity to the firmware development. In addition with a state-machines support, co-routines, time control and the inter-task communication primitives, QuarkTS provides a modern environment to build stable and predictable event-driven multitasking embedded software. Their modularity and reliability make this OS a great choice to develop efficiently a wide range of applications in low-cost devices, including automotive controls, monitoring and Internet of Things.
4543

4644
### Why should I choose it?
4745

48-
QuarkTS is not intended to replace o compete with the other great and proven RTOS options already available today, for example [FreeRTOS](https://freertos.org/) or [MicroC/OS-II](https://www.micrium.com/rtos/), in fact, you should check these options first. However, due to its size and features, is intended to play in the space between RTOSes and bare-metal. QuarkTS was written for embedded developers who want more functionality than what existing task schedulers offer, but want to avoid the space and complexity of a full RTOS, keeping the taste of a robust and safe one.
46+
QuarkTS is not intended to replace o compete with the other great and proven RTOS options already available today, for example [FreeRTOS](https://freertos.org/) or [MicroC/OS-II](https://www.micrium.com/rtos/), in fact, you should check these options first. However, due to its size and features, is intended to play in the space between RTOSes and bare-metal. QuarkTS was written for embedded developers who want more functionality than what existing task schedulers offer, but want to avoid the space and complexity of a full RTOS, keeping the taste of a robust and safe one.
4947

5048
### Support for C++ and Arduino
5149

52-
- Check the C++ port : **QuarkTS++** [here](https://github.com/kmilo17pet/QuarkTS-cpp)
50+
- Check the C++ port : **QuarkTS++** [here](https://github.com/kmilo17pet/QuarkTS-cpp)
5351
- Also available for [Arduino](https://reference.arduino.cc/reference/en/libraries/quarkts/) from the Library Manager

doc/stylesheet

0 commit comments

Comments
 (0)