Landfall

Annotated README.txt

140:e49ecec29e51
2022-01-19 Paul Boddie Added more register field definitions.
paul@21 1
Introduction
paul@21 2
============
paul@21 3
paul@21 4
Landfall is a distribution of components for the L4 Runtime Environment (L4Re)
paul@21 5
providing device support and examples for peripherals and hardware features of
paul@21 6
various computing devices, initially supporting the Ben NanoNote and Letux 400
paul@30 7
notebook computers, with additional support directed at the MIPS Creator CI20.
paul@30 8
paul@49 9
More information can be found in the docs directory in this distribution.
paul@21 10
paul@51 11
 * For reading in a text editor, see docs/wiki/Landfall
paul@49 12
 * For reading in a Web browser, see docs/html/index.html
paul@21 13
paul@49 14
A Note about the Documentation
paul@49 15
------------------------------
paul@21 16
paul@49 17
The original content in docs/wiki aims to be readable as plain text under most
paul@49 18
circumstances, but the intention is that this content be translated to HTML
paul@49 19
since it employs a formatting language based on the MoinMoin wiki format
paul@49 20
syntax.
paul@30 21
paul@49 22
The following command can be used to generate the HTML form of the
paul@49 23
documentation from the main directory of this distribution:
paul@45 24
paul@49 25
./docs/tools/make_docs.sh
paul@45 26
paul@49 27
Specify the --web option for Web server deployment:
paul@45 28
paul@49 29
./docs/tools/make_docs.sh --web
paul@30 30
paul@49 31
To generate individual documents, specify their names after any options.
paul@30 32
paul@21 33
Copyright and Licence Information
paul@21 34
=================================
paul@21 35
paul@21 36
See the following Web pages for more information about this work:
paul@21 37
paul@93 38
https://www.boddie.org.uk/paul/Landfall.html
paul@21 39
paul@21 40
The author can be contacted at the following e-mail address:
paul@21 41
paul@21 42
paul@boddie.org.uk
paul@21 43
paul@21 44
Copyright and licence information can be found in the docs directory - see
paul@21 45
docs/COPYING.txt and docs/LICENCE.txt for more information.