README 2.36 KB
Newer Older
Philippe Gerum's avatar
Philippe Gerum committed
1 2 3 4

Where to start from?
====================

Philippe Gerum's avatar
Philippe Gerum committed
5
http://xenomai.org/start-here/ is the best place to start learning
Philippe Gerum's avatar
Philippe Gerum committed
6 7
about Xenomai 3.

8 9 10
Also, make sure to read the per-architecture README files, i.e.:
kernel/cobalt/arch/*/README

11 12 13 14 15 16 17 18 19
Documentation
=============

The Xenomai 3.x documentation can be built then installed this way:

xenomai-3.x.y/configure --enable-doc-build --prefix=<install-dir>

Asciidoc, Doxygen, W3M and Dot packages are required for building the
documentation.
Philippe Gerum's avatar
Philippe Gerum committed
20 21 22 23 24 25 26

Online documentation
====================

The online version of the documentation is available from our website
for the current release:

Philippe Gerum's avatar
Philippe Gerum committed
27 28 29 30 31 32 33
http://xenomai.org/installing-xenomai-3-x/
http://xenomai.org/building-applications-with-xenomai-3-x/
http://xenomai.org/running-applications-with-xenomai-3-x/
http://xenomai.org/migrating-from-xenomai-2-x-to-3-x/
http://xenomai.org/documentation/xenomai-3/html/xeno3prm/index.html
http://xenomai.org/troubleshooting-a-dual-kernel-configuration/
http://xenomai.org/troubleshooting-a-single-kernel-configuration/
34 35 36 37 38

Building from sources
=====================

Detailed instructions for building from sources are available at:
Philippe Gerum's avatar
Philippe Gerum committed
39
http://xenomai.org/installing-xenomai-3-x/
40 41 42 43

- GIT clone:

  git://git.xenomai.org/xenomai-3.git
Philippe Gerum's avatar
Philippe Gerum committed
44
  http://git.xenomai.org/xenomai-3.git
45 46 47
  http://git.xenomai.org/xenomai-3.git

  Once the repository is cloned, make sure to bootstrap the autoconf
Gernot Hillier's avatar
Gernot Hillier committed
48
  system in the top-level directory by running scripts/bootstrap.  In
49 50 51 52 53 54 55 56 57 58
  order to do this, you will need the GNU autotools installed on your
  workstation.

  If you intend to update the Xenomai code base, you may want to pass
  --enable-maintainer-mode to the configure script for building, so
  that autoconf/automake output files are automatically regenerated at
  the next (re)build in case the corresponding templates have changed.

- Tarballs:

59
  http://xenomai.org/downloads/xenomai/
60 61

  Source tarballs are self-contained and ready for building.
62 63 64 65 66 67 68 69 70 71 72 73 74

Licensing terms
===============

Source files which implement the Xenomai software system generally
include a copyright notice and license header. In absence of license
header in a particular file, the terms and conditions stated by the
COPYING or LICENSE file present in the top-level directory of the
relevant package apply.

For instance, lib/cobalt/COPYING states the licensing terms and
conditions applicable to the source files present in the hierarchy
rooted at lib/cobalt.