From: sunghan Date: Tue, 13 Jun 2017 09:53:36 +0000 (+0900) Subject: update README X-Git-Tag: 1.1_Public_Release~513^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=19a9e93859779ba3a8117277534456f1b4197c6f;p=rtos%2Ftinyara.git update README 1. changed link from wiki.tizen.org to source.tizen.org 2. add kconfig-frontends installation 3. make some words italicized --- diff --git a/README.md b/README.md index 35e8c4b..73ab172 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,13 @@ [![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE) -lightweight RTOS-based platform to support low-end IoT devices. - -Please find project details on our [Tizen wiki](https://wiki.tizen.org/wiki/Tizen_RT). +lightweight RTOS-based platform to support low-end IoT devices. +Please find project details like **APIs**, **Specification** and **Long-term Goals** on our [Tizen Site](https://source.tizen.org/documentation/tizen-rt). ## Quick Start ### Getting the toolchain -Get the build in binaries and libraries, [gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar](https://launchpad.net/gcc-arm-embedded/4.9/4.9-2015-q3-update) - +Get the build in binaries and libraries, [gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar](https://launchpad.net/gcc-arm-embedded/4.9/4.9-2015-q3-update) Untar the gcc-arm-none-eabi-4_9-2015q3-20150921-linux.tar and export the path like ```bash @@ -28,27 +26,27 @@ TIZENRT_BASEDIR="$PWD" ### How to Build -Configure the build from $TIZENRT_BASEDIR/os/tools directory +Configure the build from *$TIZENRT_BASEDIR/os/tools* directory ```bash cd os/tools ./configure.sh / ``` -For list of boards and configuration set supported, refer belows. - -Above copies the canned configuration-set for the particular board, into the $TIZENRT_BASEDIR/os directory. - -Configuration can be modified through make menuconfig from $TIZENRT_BASEDIR/os. +For list of boards and configuration set supported, refer belows. +Above copies the canned configuration-set for the particular board, into the *$TIZENRT_BASEDIR/os* directory. +Configuration can be modified through *make menuconfig* from *$TIZENRT_BASEDIR/os*. ```bash cd .. make menuconfig ``` -Finally, initiate build by make from $TIZENRT_BASEDIR/os +Refer kconfig-frontend installation to use *menuconfig* at [APPENDIX](README.md#kconfig-frontends-installation) + +Finally, initiate build by make from *$TIZENRT_BASEDIR/os*. ```bash make ``` -Built binaries are in $TIZENRT_BASEDIR/build/output/bin. +Built binaries are in *$TIZENRT_BASEDIR/build/output/bin*. ## Supported Board @@ -62,11 +60,36 @@ sidk_s5jt200 or other boards for Tizen RT will be coming soon. ## Configuration Sets -To build a Tizen RT application, use the default configuration files named 'defconfig' under build/configs/\/\ folder. - -To customize your application with specific configuration settings, using the menuconfig tool is recommended at os folder as shown: +To build a Tizen RT application, use the default configuration files named *defconfig* under *build/configs/\/\* folder. +To customize your application with specific configuration settings, using the menuconfig tool is recommended at *os* folder as shown: ```bash make menuconfig ``` Please keep in mind that we are actively working on board configurations, and will be posting our updates on the README files under each config +## APPENDIX +### Kconfig-frontends Installation + +1. The *gperf* and *libncurses5-dev* packages should be installed. +```bash +sudo apt-get install gperf libncurses5-dev +``` + +2. Download and untar *kconfig-frontends* package. + One of site is [Yann Morin's Project](http://ymorin.is-a-geek.org/projects/kconfig-frontends) +```bash +tar -xvf kconfig-frontends-x.xx.x.x.tar.bz2 +``` + +3. Go to *kconfig-frontends* folder +```bash +cd kconfig-frontends-x.xx.x.x +``` + +4. Configure and Build +```bash +./configure --enable-mconf --disable-gconf --disable-qconf +make +sudo make install +``` +