{{{
#!html
<h1 style="text-align: center; color: #0038a6; font-size: 250%;">MutekH project home</h1>
}}}

----

= What is MutekH =

[http://www.mutek.fr/ MutekH] is a portable operating system for embedded platforms originally developped at the [http://www-soc.lip6.fr/ SoC] department of the [http://www.lip6.fr/ LIP6] Laboratory ([http://www.upmc.fr/ Université Pierre et Marie Curie] in Paris).

MutekH is a set of libraries built on top of the Hexo exo-kernel. The exo-kernel can be seen as an Hardware Abstration Layer (HAL) used to address platform and processors specific implementations. MutekH is fully configurable to match every application needs.

It currently support these platforms:
 * [wiki:Arch/Soclib Soclib] based platforms with Arm, Mips and Ppc multiprocessor support
 * [wiki:Arch/IbmPc Pc platform] with x86 multiprocessor support
 * [wiki:Arch/Emu Unix processes] (kernel and application run as standalone unix process)
 * [wiki:Arch/Simple Simple platforms] bare CPU with hardware (i.e. microcontrollers)

A list of major contributors is available [wiki:Contributors here].

= Getting started =

The following ressources are available to try MutekH easily:

 * The [wiki:QuickStartUnix MutekH as Unix process quick start guide] is a step by step guide to run MutekH embedded in a GNU/Linux or !MacOs user process.
 * The [wiki:QuickStartSoclib MutekH quick start guide for SoCLib platform] is a step by step guide to run MutekH on the Soclib multi-processor hardware simulator.
 * The [https://www.soclib.fr/trac/dev/wiki/LiveCd SoCLib livecd] provided some sample platforms and applications based on older MutekH revisions.

More advanced topics are available:

 * [wiki:UsingMutek/Sam7 Using MutekH on a AT91SAM7] Arm microcontroller based platform.

= Detailed features =

Several modules are available:
 * Native modules
  * Standard C library (libc)
  * Native Posix threads Support (libpthread)
  * TPC/IP stack networking library (libnetwork)
  * File system support library (libvfs) along with file system drivers (FAT, NFS)
  * ELF binary file format (libelf)
  * [https://www.soclib.fr/trac/dev/wiki/Tools/Muteks MutekS] (libsrl), static OS for [https://www-asim.lip6.fr/trac/dsx DSX]
  * [wiki:Drivers Device drivers for various peripherals]

 * The following library have been ported:
  * [http://www.lua.org/ Lua] scripting library (liblua)
  * [http://www.netlib.org/fdlibm/ Fdlibm] standard math library
  * [http://savannah.nongnu.org/projects/libtermui/ LibTermUI] terminal driver and getline library

 * The following modules are planed:
  * Unix kernel implementation library (libunix)

Some successfully ported applications:
 * H264 video decoder (multi-processors)
 * MJPEG and Theora multi-processor video decoder (multi-processors)
 * [http://en.wikipedia.org/wiki/Doom_%28video_game%29 Doom] video game with network multiplayer support
 * Various application using the [http://www.lua.org Lua] script engine

= Documentation =

Quickstart and tutorial documents:

 * [wiki:QuickStartUnix MutekH as Unix process quick start guide]
 * [wiki:QuickStartSoclib MutekH quick start guide for SoCLib platform]
 * [PortingYourApp Porting your application]
 * [wiki:UsingMutek/Sam7 Using MutekH on a AT91SAM7]

Developper documentation:

 * [http://www.mutek.fr/www/mutekh_api/ MutekH API reference manual]
 * Writing [wiki:HeaderDoc header documentation] for the API reference manual.
 * Using the BuildSystem
 * [NewDriver Adding a driver], or [NewDriverClass adding a new driver class]
 * Usage of IntegerTypes in MutekH

= Getting the source =

MutekH is being actively developped, now tarball releases are available yet.

Last source code can be downloaded from the svn source tree:

{{{
svn co https://www-asim.lip6.fr/svn/mutekh/trunk/mutekh
}}}

= Contact =

 * A mailing list is available for questions, announcements... You may freely [http://www-asim.lip6.fr/wws/subscribe/mutek-devel subscribe here].