diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2014-04-09 23:20:17 +0200 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2014-04-09 23:21:16 +0200 |
| commit | b67e837287278b0212b3a3c233018605fdabc8ff (patch) | |
| tree | ebf4e3aa8bdc03f80f4b24b25d8257b3eaa5bcd0 | |
| parent | d25f934944a6c3f4141158119474ad3d15ca9b7c (diff) | |
| download | mux-b67e837287278b0212b3a3c233018605fdabc8ff.tar.gz mux-b67e837287278b0212b3a3c233018605fdabc8ff.tar.bz2 mux-b67e837287278b0212b3a3c233018605fdabc8ff.zip | |
update readme
| -rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -1,11 +1,19 @@ # μx -Mux is a realtime preemptive kernel for 8-bit AVR microcontrollers. It is designed in a modular, easily extensible way. +Mux is a real-time preemptive kernel for 8-bit AVR microcontrollers. It is designed in a modular, easily extensible way. ## Requirements - avr binutils (compiler and avr c library) +## Usage +Mux is divided into three types of components: +1. kernel (in "kernel"), self explanatory, contains kernel sources +2. application (in "apps"), can call any kernel functions and represent the actual logic in a firmware build +3. hardware modules ("in modules"), custom hardware modules, such as specifically connected circuit boards, that may be used by applications + +Creating an application that uses mux as a kernel is easy, simply copy the template application and edit the various entry points (best described by looking at the template source code) to use your business code. Compile the application and kernel to a firmware image with `APP=<appname> make`. Upload `make upload`. + ## Credits -Mux was designed by Jakob Odersky. Context switching is inspired by the [FreeRTOS](http://www.freertos.org/) kernel and some parts, for example linked lists, from Linux. +Mux was designed by Jakob Odersky. Context switching is inspired by the [FreeRTOS](http://www.freertos.org/) kernel and some parts, for example linked lists, from the Linux kernel. ## License Mux is distributed under the GNU General Public License (GPL).
\ No newline at end of file |