From 67a8d8eac2117c5c1d2d54ea833fc1238eda97ba Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Wed, 13 Jul 2016 09:00:35 +0100 Subject: [PATCH] Use markdown formatting for README. --- README | 48 ------------------------------------------------ README.md | 14 +++++++------- 2 files changed, 7 insertions(+), 55 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index d9cc700..0000000 --- a/README +++ /dev/null @@ -1,48 +0,0 @@ ---------------------------------------------------------------------------- - -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) diff --git a/README.md b/README.md index d9cc700..2381d59 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ --------------------------------------------------------------------------- -Library: Atomthreads -Author: Kelvin Lawson -Website: http://atomthreads.com -License: BSD Revised + * Library: Atomthreads + * Author: Kelvin Lawson + * Website: http://atomthreads.com + * License: BSD Revised --------------------------------------------------------------------------- @@ -39,9 +39,9 @@ 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 + * kernel: Core kernel sources + * tests: Automated test suite + * ports: CPU architecture ports ---------------------------------------------------------------------------