Skip to content

Commit

Permalink
README.md : Tizen RT is renamed TizenRT.
Browse files Browse the repository at this point in the history
For better look and feel, the space between 'Tizen' and 'RT' is removed.
  • Loading branch information
davidfather committed Feb 6, 2018
1 parent 28ce39b commit 5abeb78
Show file tree
Hide file tree
Showing 86 changed files with 808 additions and 808 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tizen RT
# TizenRT

[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)
[![Build Status](https://travis-ci.org/Samsung/TizenRT.svg?branch=master)](https://travis-ci.org/Samsung/TizenRT)
Expand Down Expand Up @@ -69,7 +69,7 @@ QEMU [[details]](build/configs/qemu/README.md)

## Configuration Sets

To build a Tizen RT application, use the default configuration files named *defconfig* under *build/configs/\<board\>/\<configuration_set\>* folder.
To build a TizenRT application, use the default configuration files named *defconfig* under *build/configs/\<board\>/\<configuration_set\>* folder.
To customize your application with specific configuration settings, using the menuconfig tool is recommended at *os* folder as shown:
```bash
make menuconfig
Expand Down
2 changes: 1 addition & 1 deletion apps/HowtoAddNewApp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to add new application

The following files are required to integrate a new application with the Tizen RT build system:
The following files are required to integrate a new application with the TizenRT build system:
- **Source file**
- [**Kconfig**](#kconfig)
- [**Kconfig_ENTRY**](#kconfig_entry)
Expand Down
2 changes: 1 addition & 1 deletion apps/examples/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Built binary can be written into flash, using OpenOCD.

Please see the [Environment Set-up](../../../build/configs/sidk_s5jt200/README.md#environment-set-up) to use OpenOCD.

After building Tizen RT, follow below steps at $TIZENRT_BASEDIR/os folder.
After building TizenRT, follow below steps at $TIZENRT_BASEDIR/os folder.

### Using download script

Expand Down
4 changes: 2 additions & 2 deletions apps/examples/iotivity_simpleserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Select the 'Enable build IoTivity Samples' example in menuconfig.


## How to test
### Server (Tizen RT)
Flash Tizen RT binary to the board.
### Server (TizenRT)
Flash TizenRT binary to the board.

Run the TASH
```bash
Expand Down
10 changes: 5 additions & 5 deletions build/configs/artik053/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ SUBSYSTEMS=="usb",ATTRS{idVendor}=="0403",ATTRS{idProduct}=="6010",MODE="0666" R

There are two methods, using OpenOCD or script.

After building Tizen RT, follow below steps at $TIZENRT_BASEDIR/os folder.
After building TizenRT, follow below steps at $TIZENRT_BASEDIR/os folder.

TIZENRT_BASEDIR was set at [[Getting the sources]](../../../README.md#getting-the-sources) tab of Quick Start.

Expand Down Expand Up @@ -214,14 +214,14 @@ Before executing below board-specific steps, execute [generic steps](../../../to
```bash
Hardware Configuration -> Board Selection -> Automount partitions -> Automount romfs partiton to y
```
4. Build Tizen RT and flash a binary [using download script](#using-download-script)
4. Build TizenRT and flash a binary [using download script](#using-download-script)

## Configuration Sets

#### [audio](audio/README.md)
This can be used to test audio functionality.
#### [extra](extra/README.md)
This can be used to use full functionality of Tizen RT on ARTIK053.
This can be used to use full functionality of TizenRT on ARTIK053.
#### [hello](hello/README.md)
This provides simple hello world application including kernel.
#### [iotivity](iotivity/README.md)
Expand All @@ -231,10 +231,10 @@ This can be used to use IoT.js
#### [kernel_sample](kernel_sample/README.md)
This can be used to test kernel functionality.
#### [minimal](minimal/README.md)
This can be used to use the minimal functionality of Tizen RT on ARTIK053.
This can be used to use the minimal functionality of TizenRT on ARTIK053.
#### [nettest](nettest/README.md)
This can be used to test network functionality.
#### [st_things](st_things/README.md)
This can be used to test Smart Things Things SDK functionality.
#### [tc](tc/README.md)
This can be used to test database, file system, kernel, network functionality of Tizen RT on ARTIK053.
This can be used to test database, file system, kernel, network functionality of TizenRT on ARTIK053.
2 changes: 1 addition & 1 deletion build/configs/artik053/extra/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# extra
This can be used to use full functionality of Tizen RT on ARTIK053.
This can be used to use full functionality of TizenRT on ARTIK053.

## Enabled Feature
### File system
Expand Down
2 changes: 1 addition & 1 deletion build/configs/artik053/tc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# tc
This can be used to test database, file system, kernel, network functionality of Tizen RT on ARTIK053.
This can be used to test database, file system, kernel, network functionality of TizenRT on ARTIK053.

## Enabled Feature
### Database
Expand Down
4 changes: 2 additions & 2 deletions build/configs/artik053s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ SUBSYSTEMS=="usb",ATTRS{idVendor}=="0403",ATTRS{idProduct}=="6010",MODE="0666" R

There are two methods, using OpenOCD or script.

After building Tizen RT, follow below steps at $TIZENRT_BASEDIR/os folder.
After building TizenRT, follow below steps at $TIZENRT_BASEDIR/os folder.

TIZENRT_BASEDIR was set at [[Getting the sources]](../../../README.md#getting-the-sources) tab of Quick Start.

Expand Down Expand Up @@ -214,7 +214,7 @@ Before executing below board-specific steps, execute [generic steps](../../../to
```bash
Hardware Configuration -> Board Selection -> Automount partitions -> Automount romfs partiton to y
````
4. Build Tizen RT and flash a binary [using download script](#using-download-script)
4. Build TizenRT and flash a binary [using download script](#using-download-script)
## Configuration Sets
Expand Down
4 changes: 2 additions & 2 deletions build/configs/artik055s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ SUBSYSTEMS=="usb",ATTRS{idVendor}=="0403",ATTRS{idProduct}=="6010",MODE="0666" R

There are two methods, using OpenOCD or script.

After building Tizen RT, follow below steps at $TIZENRT_BASEDIR/os folder.
After building TizenRT, follow below steps at $TIZENRT_BASEDIR/os folder.

TIZENRT_BASEDIR was set at [[Getting the sources]](../../../README.md#getting-the-sources) tab of Quick Start.

Expand Down Expand Up @@ -220,4 +220,4 @@ Before executing below board-specific steps, execute [generic steps](../../../to
```bash
Hardware Configuration -> Board Selection -> Automount partitions -> Automount romfs partiton to y
````
4. Build Tizen RT and flash a binary [using download script](#using-download-script)
4. Build TizenRT and flash a binary [using download script](#using-download-script)
6 changes: 3 additions & 3 deletions build/configs/qemu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Targets Supported:

1. lm3s6963-ek
NOTE:
Tizen RT supports three memory options for lm3s6963-ek board;
TizenRT supports three memory options for lm3s6963-ek board;
- 64KB RAM requirement configuration which matches with real memory of lm3s6963-ek board
- 1MB RAM requirement which can be run on QEMU only with the patch in TizenRT/build/configs/qemu/qemu-2.10.0-rc2_1m_ram_size.patch
- 16MB RAM requirement which can be run on QEMU only with the patch in TizenRT/build/configs/qemu/qemu-2.10.0-rc2_16m_ram_size.patch
Expand All @@ -32,7 +32,7 @@ sudo ln qemu-system-arm /usr/local/bin/qemu-system-arm
## How to program a binary

There are two methods, using QEMU command or make command.
After building Tizen RT, follow below steps at $TIZENRT_BASEDIR/os folder.
After building TizenRT, follow below steps at $TIZENRT_BASEDIR/os folder.
TIZENRT_BASEDIR was set at [[Getting the sources]](../../../README.md#getting-the-sources) tab of Quick Start.

### Using QEMU command
Expand All @@ -49,7 +49,7 @@ make download

## How to debug

To debug Tizen RT on QEMU, GDB should be connected through below commands.
To debug TizenRT on QEMU, GDB should be connected through below commands.

```
arm-none-eabi-gdb
Expand Down
6 changes: 3 additions & 3 deletions build/configs/sidk_s5jt200/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ SUBSYSTEMS=="usb",ATTRS{idVendor}=="0403",ATTRS{idProduct}=="6010",MODE="0666" R

## How to program a binary

After buiding a Tizen RT, execute below at $TIZENRT_BASEDIR/os folder.
After buiding a TizenRT, execute below at $TIZENRT_BASEDIR/os folder.

TIZENRT_BASEDIR was set at [[Getting the sources]](../../../README.md#getting-the-sources) tab of Quick Start.
```bash
Expand Down Expand Up @@ -133,10 +133,10 @@ Before executing below steps, execute [generic steps](../../../tools/fs/README_R
Hardware Configuration -> Board Selection -> Automount partitions -> Automount ROM read only partition to y
```

After above two steps, build Tizen RT and program a Tizen RT binary through above [method](#how-to-program-a-binary).
After above two steps, build TizenRT and program a TizenRT binary through above [method](#how-to-program-a-binary).

## Using GDB
1. Build Tizen RT and program a Tizen RT binary through above [method](#how-to-program-a-binary)
1. Build TizenRT and program a TizenRT binary through above [method](#how-to-program-a-binary)

2. Run GDB server by running openocd with gdb cfg
```bash
Expand Down
6 changes: 3 additions & 3 deletions docs/HowToAddStaticLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ VPATH += chip/abc
EXTRA_LIBS += chip/abc/libnew.a
```

This change makes it add to Tizen RT binary by Makefile which is at *os/arch/arm/src* folder.
This change makes it add to TizenRT binary by Makefile which is at *os/arch/arm/src* folder.
```
$(BIN_DIR)/tinyara$(EXEEXT): $(HEAD_OBJ) board/libboard$(LIBEXT)
$(Q) echo "LD: tinyara"
Expand All @@ -29,7 +29,7 @@ $(BIN_DIR)/tinyara$(EXEEXT): $(HEAD_OBJ) board/libboard$(LIBEXT)

## Adding it as a new library

Tizen RT includes it as separated library, not merge it to existed library.
TizenRT includes it as separated library, not merge it to existed library.

1. Add it in *Libtargets.mk*.
```
Expand All @@ -50,6 +50,6 @@ Tizen RT includes it as separated library, not merge it to existed library.
```
In flat build, there is no difference between TINYARALIBS and USERLIBS.
But in protected build and kernel build, Tizen RT splits kernel space and user space. So, new static library should be included at appropriate space.
But in protected build and kernel build, TizenRT splits kernel space and user space. So, new static library should be included at appropriate space.
The *LIB_PATH* should be a relative path from *os*.
4 changes: 2 additions & 2 deletions docs/HowToAddnewBoard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Adding static library or expanding driver will be provided later.
## Arch

Changes in *arch* directory for a new board includes chip architecture and BSP for board.
Currently, Tizen RT supports only ARM architecture.
Currently, TizenRT supports only ARM architecture.
But if new board is another architecture, new architecture folder should be added in this path.

### BSP
Expand Down Expand Up @@ -97,7 +97,7 @@ mkdir build/configs/<board-name>/<program-name>
### defconfig

This is a configurations set of representing folder name.
This is moved to .config at executing configure.sh and used to build Tizen RT.
This is moved to .config at executing configure.sh and used to build TizenRT.

### Make.defs

Expand Down
8 changes: 4 additions & 4 deletions docs/HowToDevelopThingsUsingSmartThingsThingsSDK.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# How to develop things using SmartThings Things SDK based Tizen RT
# How to develop things using SmartThings Things SDK based TizenRT

SmartThings Things(ST-Things) SDK is lightweight OCF development framework based Tizen RT.
SmartThings Things(ST-Things) SDK is lightweight OCF development framework based TizenRT.
It provides APIs to develop OCF devices and supports Samsung Connect Services provided by Samsung mobile devices to easily connect Samsung Cloud.

## Prerequisites
### 1. To use Tizen RT
### 1. To use TizenRT
Please refer to each details.

- Toolchain installation [[Details]](../README.md#getting-the-toolchain)
Expand All @@ -14,7 +14,7 @@ Please refer to each details.


### 2. To use Samsung Cloud
A device developed using ST-Things SDK based Tizen RT can connect to Samsung Cloud.
A device developed using ST-Things SDK based TizenRT can connect to Samsung Cloud.
In order to work with the cloud, it is necessary to sign up Samsung Account at [SmartThings Developers](https://smartthings.developer.samsung.com/) site.
Then, follow the steps.
1. Get your MNID - Manufacturer ID - on [My Page](https://smartthings.developer.samsung.com/partner/dashboard)
Expand Down
2 changes: 1 addition & 1 deletion docs/HowToDevelopThingsWithTizenStudioForRT.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ If you edit the SmartThings resources in your project later on, the Model Manage

### 4. Build and Flash the Project
You must build your project before flashing or debugging it.
You can build a Tizen RT project in 2 ways: [using a batch build](#Using-Batch-Build) or [build project command](#Using-Build-Project).
You can build a TizenRT project in 2 ways: [using a batch build](#Using-Batch-Build) or [build project command](#Using-Build-Project).

#### Using Batch Build
To build your project using the batch build command:
Expand Down
12 changes: 6 additions & 6 deletions external/include/mbedtls/easy_tls.h
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ typedef struct tls_session_context {
* @param[in] cred a structure pointer of key and certificates
* @return On success, a structure pointer of tls context will be returned.
* On failure, NULL will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
tls_ctx *TLSCtx(tls_cred *cred);
Expand All @@ -113,7 +113,7 @@ tls_ctx *TLSCtx(tls_cred *cred);
* @param[in] ctx a structure pointer of tls context.
* @return On success, TLS_SUCCESS(0) will be returned.
* On failure, positive value will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
int TLSCtx_free(tls_ctx *ctx);
Expand All @@ -128,7 +128,7 @@ int TLSCtx_free(tls_ctx *ctx);
* @param[in] opt a structure pointer including several tls options.
* @return On success, a structure pointer of tls session context will be returned.
* On failure, positive value will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
tls_session *TLSSession(int fd, tls_ctx *ctx, tls_opt *opt);
Expand All @@ -140,7 +140,7 @@ tls_session *TLSSession(int fd, tls_ctx *ctx, tls_opt *opt);
* @param[in] session a structure pointer of tls session context.
* @return On success, TLS_SUCCESS(0) will be returned.
* On failure, positive value will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
int TLSSession_free(tls_session *session);
Expand All @@ -154,7 +154,7 @@ int TLSSession_free(tls_session *session);
* @param[in] size send data size.
* @return On success, sent size will be returned.
* On failure, 0 or negative value will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
int TLSSend(tls_session *session, unsigned char *buf, size_t size);
Expand All @@ -168,7 +168,7 @@ int TLSSend(tls_session *session, unsigned char *buf, size_t size);
* @param[in] size received data size.
* @return On success, received size will be returned.
* On failure, 0 or negative value will be returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*
*/
int TLSRecv(tls_session *session, unsigned char *buf, size_t size);
Expand Down
6 changes: 3 additions & 3 deletions external/include/protocols/dhcpc.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ extern "C" {
* @param[in] mac_addr the mac address of network interface
* @param[in] mac_len the length of mac address
* @return On success, handle. On failure, returns null
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
void *dhcpc_open(const char *intf);

Expand All @@ -118,7 +118,7 @@ void *dhcpc_open(const char *intf);
* @param[in] handle generic data structure that contains dhcpc information
* @param[out] presult dhcp informations that contain ip address, netmask and gateway
* @return On success, 0. On failure, returns negative
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
int dhcpc_request(void *handle, struct dhcpc_state *presult);

Expand All @@ -127,7 +127,7 @@ int dhcpc_request(void *handle, struct dhcpc_state *presult);
*
* @param[in] handle generic data structure that contains dhcpc information
* @return none
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
void dhcpc_close(void *handle);

Expand Down
6 changes: 3 additions & 3 deletions external/include/protocols/ntpclient.h
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ extern "C" {
* @param[in] link_error_cb callback function for link error case
* @return On success, the non-negative task ID of the NTPC daemon is returned.
* On failure, a negative value is returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
int ntpc_start(struct ntpc_server_conn_s *server_list, uint32_t num_of_servers, uint32_t interval_secs, void *link_error_cb);

Expand All @@ -154,7 +154,7 @@ int ntpc_start(struct ntpc_server_conn_s *server_list, uint32_t num_of_servers,
*
* @param[in] none
* @return On success, 0 is returned. On failure, a negative value is returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
#ifndef CONFIG_DISABLE_SIGNALS
int ntpc_stop(void);
Expand All @@ -165,7 +165,7 @@ int ntpc_stop(void);
*
* @param[in] none
* @return ntpc daemon's status value is returned (please, refer to enum ntpc_daemon_e definition).
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/
int ntpc_get_status(void);

Expand Down
8 changes: 4 additions & 4 deletions external/include/protocols/webclient.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ extern "C" {
* @param[in] response a structure pointer of response message.
* @return On success, OK(0) is returned.
* On failure, negative value is returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/

int http_client_send_request(struct http_client_request_t *request, void *ssl_config, struct http_client_response_t *response);
Expand All @@ -184,7 +184,7 @@ int http_client_send_request(struct http_client_request_t *request, void *ssl_co
* @param[in] cb a function pointer called when receive response.
* @return On success, OK(0) is returned.
* On failure, negative value is returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/

int http_client_send_request_async(struct http_client_request_t *request, void *ssl_config, wget_callback_t cb);
Expand All @@ -195,7 +195,7 @@ int http_client_send_request_async(struct http_client_request_t *request, void *
* @param[in] response a structure pointer of response message.
* @return On success, OK(0) is returned.
* On failure, negative value is returned.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/

int http_client_response_init(struct http_client_response_t *response);
Expand All @@ -205,7 +205,7 @@ int http_client_response_init(struct http_client_response_t *response);
*
* @param[in] response a structure pointer of response message.
* @return N/A.
* @since Tizen RT v1.0
* @since TizenRT v1.0
*/

void http_client_response_release(struct http_client_response_t *response);
Expand Down
Loading

0 comments on commit 5abeb78

Please sign in to comment.