RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

* created a mainpage for the RIOT documentation

Browse Source
This commit is contained in:
Oleg Hahm 2013-03-07 22:22:25 +01:00
parent 77859ebc90
commit 4f45305805
3 changed files with 48 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/doxygen/riot.doxyfile
View File

@ -85,9 +85,9 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../../core ../../cpu ../../board ../../sys ../manual ../../drivers
INPUT = ../../core ../../cpu ../../board ../../sys src/ ../../drivers
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.doc *.c *.h
FILE_PATTERNS = *.txt *.c *.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
@ -148,7 +148,7 @@ QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
FORMULA_FONTSIZE = 10
#---------------------------------------------------------------------------

40
doc/doxygen/src/mainpage.txt Normal file
View File

@ -0,0 +1,40 @@
/*! \mainpage RIOT Documentation
*
* RIOT is an operating system for the Internet of Things, based on a microkernel architecture.
*
* \section first_sec First steps
*
* \subsection getting_sec Getting RIOT
*
* You can obtain the latest RIOT code from our [Github](https://github.com/) account. There exist three repositories:
* - [RIOT](https://github.com/RIOT-OS/RIOT)\n
* This contains the kernel, support for different CPUs, device drivers, and system libraries.\n
* It also provides you additional tools like a terminal program or scripts to setup a toolchain.\n
* You will always need a copy if you want to use RIOT.
* - [boards](https://github.com/RIOT-OS/boards)
* This repository contains configuration files and hardware initialization code for various supported hardware platforms.\n
* You need this code only if you want to use RIOT on one of these boards:
* -# [MSB-A2](http://www.mi.fu-berlin.de/inf/groups/ag-tech/projects/Z_Finished_Projects/ScatterWeb/modules/mod_MSB-A2.html)
* -# PTTU
* -# [MSB-430(H)](http://www.mi.fu-berlin.de/inf/groups/ag-tech/projects/Z_Finished_Projects/ScatterWeb/modules/mod_MSB-430H.html)
* -# [EZ430-Chronos](http://processors.wiki.ti.com/index.php/EZ430-Chronos)\n
* You will also need this code to run RIOT as a program on your development system.
* - [projects](https://github.com/RIOT-OS/projects)\n
* Here you can find some exemplary applications.\n
*
* \subsection compile_sec Compiling RIOT
*
* Depending on the hardware you want to use, you need first to install a corresponding toolchain. An example of how to install a toolchain for a platform using an ARM7 can be found in our [Wiki](https://github.com/RIOT-OS/boards/wiki/For-MSB-A2).\n
* Once you have setup the toolchain, you can create your own project. Therefore, you will only need C-File containing your source code and a Makefile. A Template for a Makefile is available in the [RIOT repository](https://github.com/RIOT-OS/RIOT) in the `dist` folder.\n
* Within your project's Makefile you can define the target hardware as well as the modules you want to use.\n
* Make will create an elf-file and a Intel hexfile to program your node within the `bin` folder in your project directory (unless otherwise specified).
*
* \subsection native_sec Native RIOT - Run RIOT on your PC!
*
* As a special platform you will find a CPU and board called `native` in the repository. This target allows to run RIOT as a program in Linux on almost every available hardware platform. Just choose `native` as CPU and BOARD in your project's Makefile, call `make` and execute the resulting elf-file directly on your computer. More information about the native implementation can be found on the [developer's homepage](http://ludwig.tatzen.net/blog/design/index.html).
*
* \section info_sec Community
*
* Whether you are looking for help with writing an application for RIOT, learn more about it, or just want to stay in the loop, you are invited to join the RIOT-users mailing list. For developers who want to participate and contribute to the kernel development or integrate new MCU and platform support, the [RIOT-devel mailing list(http://lists.riot-os.org/mailman/listinfo/devel) is the right place.
*
*/

8
doc/doxygen/src/riot.css
View File

@ -7,9 +7,8 @@ BODY,TD {
h1 { /* titel */
text-align: left;
font-size: 140%;
background-color: #aabbbd; /*#f4f4f4; */
padding: 0.3em 0.3 0em 0.3em;
height: 80px;
background-color: #d4d4d4;
padding: 0.3em 0.3 0.3em 0.3em;
margin-top: 0;
}
h1,
@ -27,6 +26,9 @@ td h2 { /* member table captions */
h3 { /* subsection */
font-size: 100%;
}
div.title {
font-size: 200%;
}
div.agtlogo {
float: left;
position: relative;