README.dox

/**

 * \mainpage

 * \section intro Introduction
 * - Barista: An Event-centric Composable NOS for Software-Defined Networks (SDN Controller)

 * \section config Configuration
 * - The configuration file of the Barista NOS: config.mk \n
 * - The configuration files of applications and components: bin/config \n
 * - The credentials for a CLI and a database: bin/secret

 * \section test Test environment
 * - The current Barista is tested on Ubuntu 16.04. \n
 * - It may work on other Linux platforms if its dependency issues are solved.

 * \section compile Compilation
 * 1. Install dependencies \n
 * $ ./deps.sh \n
 * After setting 'root' password, please update'bin/secret/db_password.txt' as well \n
 * 2. Compile the source code of Barista NOS \n
 * $ make \n
 * 3. Clean up the compiled files for Barista NOS \n
 * $ make clean \n

 * \section run Execution
 * - Run the Barista NOS \n
 * $ cd bin \n
 * $ ./barista \n
 * - Run the Barista NOS automatically \n
 * $ ./barista -r \n
 * - Run the Barista NOS as a daemon \n
 * $ ./barista -d \n
 * - Run the Barista NOS with base components \n
 * $ ./barista -b \n
 * - Connect the CLI of the Barista NOS \n
 * $ telnet localhost 8000 (default port) \n
 * (default ID: admin, default PW: password)

 * \section cli CLI commands
 * - Change a configuration mode \n
 * Barista> turn on/off \n
 * - Load configurations \n
 * Barista# load \n
 * - Start the Barista NOS \n
 * Barista# start \n
 * - Stop the Barista NOS \n
 * Barista# stop \n
 * - More information? \n
 * Barista\> help

 * \section develop Author
 * - Jaehyun Nam <namjh@kaist.ac.kr>

 */