Cedric Roux
56c66c09aa
Pre-ci test passed git-svn-id: http://svn.eurecom.fr/openair4G/trunk@4000 818b1a75-f10b-46b9-bf7c-635c3b92a50f
113 lines
3.6 KiB
Plaintext
113 lines
3.6 KiB
Plaintext
/*******************************************************************************
|
|
|
|
OPENAIRINTERFACE 0/1/2/3
|
|
Copyright(c) 1999 - 2010 EURECOM
|
|
|
|
This program is free software; you can redistribute it and/or modify it
|
|
under the terms and conditions of the GNU General Public License,
|
|
version 2, as published by the Free Software Foundation.
|
|
|
|
This program is distributed in the hope it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
The full GNU General Public License is included in this distribution in
|
|
the file called "COPYING".
|
|
|
|
Contact Information:
|
|
Openair Admin <openair_admin@eurecom.fr>
|
|
Mailing List <openair_tech@eurecom.fr>
|
|
Forums http://forums.eurecom.fr/openairinterface
|
|
Eurecom, 2229, route des cretes, 06560 Valbonne Sophia Antipolis, France
|
|
|
|
*******************************************************************************/
|
|
|
|
/*! \file Readme.doxy
|
|
* \brief explain how this block is organized, and how it works
|
|
* \author Navid Nikaein
|
|
* \date 2009
|
|
* \version 0.1
|
|
* \company Eurecom
|
|
* \note This conde is under GNU GENERAL PUBLIC LICENSE, version 2, June 1991
|
|
* \email: navid.nikaein@eurecom.fr
|
|
* \warning
|
|
*/
|
|
|
|
/*! \mainpage Table of contents
|
|
|
|
The content of this readme is the following:
|
|
|
|
-# What is this block about in OpenAirInterface
|
|
-# Folders and files description
|
|
-# Organization of the folders and their dependancies
|
|
-# Makefile targets and how to build
|
|
-# How to use through a tutorial: run a simple experimentation
|
|
|
|
|
|
\section _block What is this block about in OpenAirInterface ?
|
|
|
|
|
|
It essentially means "the hardware part" located at openair0.
|
|
|
|
Explain through the figures:
|
|
\image html image.png "caption" width=3cm
|
|
\image latex image.pdf "caption"
|
|
|
|
More information about ??? can be found on the Twiki:
|
|
https://twiki.eurecom.fr/twiki/bin/view/OpenAirInterface/WebHome
|
|
|
|
|
|
\section _folders Folders and files description
|
|
|
|
The structure is the following:
|
|
<table>
|
|
<tr><td>File/Folder</td> <td> Description </td> </tr>
|
|
</table>
|
|
|
|
- Folder1: Contains this and that
|
|
- Folder2: Contains this and that
|
|
- init.bash: A simple script file, that any user SHOULD source from its environment personal set-up script (this is typically ~/.bashrc) by adding the following lines to it:
|
|
This is my ~/.bashrc file or equivalent export OPENAIRX=path/to/my/openairX/folder source $OPENAIRX/init.bash. The file includes variable definitions & path settings to access softwares, sources & Makefiles, software distribution in openair, and so on.
|
|
|
|
|
|
YOU DEFINETELY NEED TO SOURCE THIS FILE. Description
|
|
|
|
\section _organization Organization of the folders and their dependancies
|
|
|
|
|
|
The 3 folders have the following structures
|
|
|
|
- Folder1/subfolder1/: contains any ressource related to the design
|
|
|
|
- Folder2/subfolder2/: contains
|
|
|
|
- Folder2/src/
|
|
|
|
- Folder2/lib/
|
|
|
|
- Folder2/bin/
|
|
|
|
Explain where are the source files.
|
|
Explain the relationship with other Blocks.
|
|
|
|
|
|
\section _makefile Makefile targets and how to build
|
|
|
|
Explain whether you are using symbolic links or not,
|
|
how to backup/archive
|
|
how to generate the tags
|
|
how to print the vars
|
|
how to create the documentation
|
|
|
|
\section _howto How to use through a tutorial: run a simple experimentation
|
|
...
|
|
|
|
|
|
*/
|
|
|