Release 11.0.0.17901
[platform/core/csapi/tizenfx.git] / README.md
index 6fd7081..72c201a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,47 +1,66 @@
 # TizenFX
 
-[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)
-[![BuildStatus](https://travis-ci.org/Samsung/TizenFX.svg?branch=master)](https://travis-ci.org/Samsung/TizenFX)
+[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?label=License&style=flat-square)](LICENSE)
+[![Build](https://img.shields.io/github/actions/workflow/status/Samsung/TizenFX/build-branches.yml?query=branch%3Amaster?label=Build&style=flat-square)](https://github.com/Samsung/TizenFX/actions?query=workflow%3A%22Build+Branches%22+branch%3Amaster)
 
-TizenFX API, which allows you to access platform-specific features not covered by the generic .NET and Xamarin.Forms features, such as system information and status, battery status, sensor date, and account and connectivity services.
-
-## Contents
-> [Branches of TizenFX](#branches)  
-> [Quick Start](#quick-start)  
-> [Tizen Project](#tizen-project)
+TizenFX API, which allows you to access platform-specific features not covered by the generic .NET and .NET MAUI features, such as system information and status, battery status, sensor date, and account and connectivity services.
 
 ## Branches
 
-| branch | API level | platform          | pre-release | stable |
-|--------|:---------:|-------------------|-------------|--------|
-|master  | 5         | Tizen vNext (5.0) | [![api5_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API5.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | |
-|API4    | 4         | Tizen 4.0         | [![api4_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API4.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api4_nuget](https://img.shields.io/nuget/v/Tizen.NET.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+| Branch | API Level | Target Framework | API Reference | Platform          | myget.org | nuget.org  |
+|--------|:---------:|------------------|---------------|-------------------|-----------|------------|
+|master  | 11        | tizen11.0 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext | [![api11_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API11.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) |  |
+|API10   | 10        | tizen10.0 | [Link](https://samsung.github.io/TizenFX/API10/) | Tizen 7.0 | [![api10_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API10.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api10_nuget](https://img.shields.io/nuget/v/Tizen.NET.API10.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API9    | 9         | tizen90   | [Link](https://samsung.github.io/TizenFX/API9/) | Tizen 6.5 | [![api9_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API9.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api9_nuget](https://img.shields.io/nuget/v/Tizen.NET.API9.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API8    | 8         | tizen80   | [Link](https://samsung.github.io/TizenFX/API8/) | Tizen 6.0 | [![api8_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API8.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api8_nuget](https://img.shields.io/nuget/v/Tizen.NET.API8.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API7    | 7         | tizen70   | [Link](https://samsung.github.io/TizenFX/API7/) | Tizen 5.5 M3 | [![api7_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API7.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api7_nuget](https://img.shields.io/nuget/v/Tizen.NET.API7.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API6    | 6         | tizen60   | [Link](https://samsung.github.io/TizenFX/API6/) | Tizen 5.5 M2 | [![api6_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API6.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api6_nuget](https://img.shields.io/nuget/v/Tizen.NET.API6.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API5    | 5         | tizen50   | [Link](https://samsung.github.io/TizenFX/API5/) | Tizen 5.0       | [![api5_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API5.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api5_nuget](https://img.shields.io/nuget/v/Tizen.NET.API5.svg)](https://www.nuget.org/packages/Tizen.NET/) |
+|API4    | 4         | tizen40   | [Link](https://samsung.github.io/TizenFX/API4/) | Tizen 4.0         | [![api4_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API4.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | [![api4_nuget](https://img.shields.io/nuget/v/Tizen.NET.API4.svg)](https://www.nuget.org/packages/Tizen.NET/) |
 
 ### master
-The __master__ branch is the main development branch for the Tizen .NET __API Level 5__.
-
-The following NuGet packages will be published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) every day if there are any changes. (Nightly Build) 
-* Tizen.NET-5.0.0-preview#-#####
-* Tizen.NET.API5-5.0.0-preview#-#####
-* Tizen.NET.Internals-5.0.0.#####
+The __master__ branch is the main development branch for the Tizen .NET __API Level 11__.
 
-And, This branch is pushed to the [tizen branch](https://git.tizen.org/cgit/platform/core/csapi/tizenfx/?h=tizen) in the tizen gerrit and submmited for the Tizen vNext (5.0) platform.
+The following NuGet packages will be published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) every day if there are any changes. (Nightly Build)
+* Tizen.NET 11.0.0.#####
+* Tizen.NET.API11 11.0.0.#####
+* Tizen.NET.Internals 11.0.0.#####
 
-### API4
-The __API4__ branch is the release branch for Tizen .NET __API Level 4__. 
+And, This branch is pushed to the [tizen branch](https://git.tizen.org/cgit/platform/core/csapi/tizenfx/?h=tizen) in the tizen gerrit and submitted for the Tizen vNext platform.
 
-The API Level 4 was __FROZEN__. No new public APIs can be added to this branch, only bug fixes and internal APIs can be added.
+### API4 ~ API10 branches
+The __API#__ branches are the release branch for Tizen .NET __API Level #__.
 
-The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
-* Tizen.NET-4.0.1-preview#-#####
-* Tizen.NET.API4-4.0.1-preview#-#####
-* Tizen.NET.Internals-4.0.1.#####
+These release branches were __FROZEN__. No new public APIs can be added to these branches, only bug fixes and internal APIs can be added.
 
-And, This branch is pushed to the [tizen_4.0 branch](https://git.tizen.org/cgit/platform/core/csapi/tizenfx/?h=tizen_4.0) in the tizen gerrit and submmited for the Tizen 4.0 platform.
+## Using `tizen` target framework
+If you want to use the `tizen` target framework, you need to use `Tizen.NET.Sdk` package as the project sdk.
+```xml
+<Project Sdk="Tizen.NET.Sdk/1.1.9">
+  <PropertyGroup>
+    <TargetFramework>tizen11.0</TargetFramework>
+  </PropertyGroup>
+</Project>
+```
+For more information, please see [Using Tizen.NET.Sdk as SDK-style](https://developer.samsung.com/tizen/blog/en-us/2019/06/13/using-tizennetsdk-as-sdk-style).
 
+### Minimum required versions of Tizen.NET.Sdk and Visual Studio
+| API Level | Target Framework | Tizen.NET.Sdk | Visual Studio     |
+|:---------:|------------------|---------------|-------------------|
+| API11     | tizen11.0        | 1.1.10 (not yet) | 2022           |
+| API10     | tizen10.0        | 1.1.9 (recommend) | 2019          |
+| API9      | tizen90          | 1.1.7         | 2019              |
+| API8      | tizen80          | 1.1.6         | 2019              |
+| API7      | tizen70          | 1.0.9         | 2019              |
+| API6      | tizen60          | 1.0.9         | 2019              |
+| API5      | tizen50          | 1.0.1         | 2017              |
+| API4      | tizen40          | 1.0.1         | 2017              |
 
 
 ## Quick Start
+### Prerequisites
+Install .NET Core SDK : https://www.microsoft.com/net/download/
+
 ### Getting the sources
 ```bash
 git clone https://github.com/Samsung/TizenFX.git
@@ -50,33 +69,17 @@ cd TizenFX
 ### How to build
 ```bash
 ./build.sh full
-./build.sh pack 
+./build.sh pack
 ```
 
-
 ## Tizen Project
-TizenFX is a part of the [Tizen project](https://www.tizen.org) and has been officially included since [4.0 M2 release](https://www.tizen.org/blogs/tsg/2017/tizen-4.0-m2-source-code-release).  
-You can download the latest binaries with TizenFX from the link below :  
+TizenFX is a part of the [Tizen project](https://www.tizen.org).
+You can download the latest binaries with TizenFX from the link below :
 
 | Tizen Version     | Link |
 |-------------------|------|
 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
-| Tizen vNext (5.0) | http://download.tizen.org/snapshots/tizen/unified/latest/ |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+| Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
+| Tizen 5.5         | http://download.tizen.org/snapshots/tizen/5.5-unified/latest/ |
+| Tizen 6.0         | http://download.tizen.org/snapshots/tizen/6.0-unified/latest/ |
+| Tizen 6.5         | http://download.tizen.org/snapshots/tizen/unified/latest/     |