From 3303dc739f85cde5c1e69cd71f9368bc23e6081a Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Wed, 13 Jul 2016 08:58:17 +0100 Subject: [PATCH] Switch to Markdown README. --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d9cc700 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +--------------------------------------------------------------------------- + +Library: Atomthreads +Author: Kelvin Lawson +Website: http://atomthreads.com +License: BSD Revised + +--------------------------------------------------------------------------- + +Atomthreads is a free RTOS for embedded systems, released under the +flexible, open source BSD license and is free to use for commercial or +educational purposes without restriction. + +It is targeted at systems that need only a lightweight scheduler and the +usual RTOS primitives. No file system, IP stack or device drivers are +included, but developers can bolt on their own as required. Atomthreads +will always be a small number of C files which are easy to port to any +platforms that require threading by adding a simple +architecture-specific file. + +--------------------------------------------------------------------------- + +DOCUMENTATION: + +All documentation is contained within the source files, commented using +Doxygen markup. Pre-generated documentation can be accessed at +http://atomthreads.com. + +See also the README file contained within each folder of the source tree. + +--------------------------------------------------------------------------- + +GETTING STARTED: + +Building of the sources is carried out from the ports tree. For example to +make a software build for the AVR architecture see ports/avr/README. + +--------------------------------------------------------------------------- + +SOURCE TREE: + + * kernel Core kernel sources + * tests Automated test suite + * ports CPU architecture ports + +--------------------------------------------------------------------------- + +[![Build Status](https://travis-ci.org/kelvinlawson/atomthreads.svg?branch=master)](https://travis-ci.org/kelvinlawson/atomthreads)