Skip to content

Latest commit

 

History

History
117 lines (64 loc) · 3.26 KB

README.md

File metadata and controls

117 lines (64 loc) · 3.26 KB
Raw

TAU

The TAU library contains components which allows you to create Web Application UI. Each components represents UI element, such as a button or slider, which gives you interaction and manipulation features.

This is replacement and clone of previously existing https://review.tizen.org/gerrit/#/admin/projects/platform/framework/web/tau

Getting Started

  • Clone a copy of the master branch in the TAU Git repository:

git clone [email protected]:Samsung/TAU.git

  • Change to the tau directory:

cd TAU

  • Check out the latest stable version of TAU:

git checkout master

Prerequisites

To build a TAU library, ensure that you have both Git and Node.js (6.16.0) installed.

Example of node install using nvm:

nvm install 6.16.0
nvm use 6.16.0

Installing

  • Install the build module by npm:

npm install

Build TAU by running the following command in the tau directory:

npm run build

Running the tests

TAU has automated tests. To run tests execute command:

npm run test

Debuggging

In order to set additional logging in TAU you need to build TAU with --tau-debug option

npx grunt build --tau-debug

Demo application:

UIComponents sample web application demonstrating how to implement UI Components for wearable based on TAU.

Demo application is available on https://samsung.github.io/TAU:

If you want to test your own version of demo app run:

npm run http-server

and visit appropriate local site:

Coding style tests

Project has defined eslint rules (.eslintrc.js)

Contribution can be verified using command:

npx grunt eslint

Usage

Refer to samsung.github.io/TAU for library usage instructions

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

TAU version comply with Semantic Versioning specification - 2.0

MAJOR.MINOR.PATCH

  • MAJOR - assures public API compatibility
  • MINOR - adds new functionalities (e.g. new API) with backward compatibility for old API
  • PATCH - backward compatible bug fixes

TAU vs Tizen compatibility

TAU 1.0 is compatible with Tizen 4.0/5.0 Web API TAU 1.1 is compatible with Tizen 5.5 Web API and backward compatible with 4.0/5.0 (apps using Tizen 4.0/5.0 Web API can use TAU 1.1 instead of TAU 1.0)

Releases

You can find releases in the releases tab

Tizen_version_number.TAU_version_for_given_Tizen_release.

E.g. in case of TAU for Tizen 5.0: 5.0.0...5.0.10, 5.0.11...

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under MIT except some files under Flora license. For details see COPYING