README.md

   1 # TizenFX
   2
   3 [![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?label=License&style=flat-square)](LICENSE)
   4 [![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)
   5
   6 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.
   7
   8 ## Branches
   9
  10 | Branch | API Level | Target Framework | API Reference | Platform          | myget.org | nuget.org  |
  11 |--------|:---------:|------------------|---------------|-------------------|-----------|------------|
  12 |master  | 12        | net6.0-tizen9.0 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext | [![api12_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API12.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) |  |
  13 |API11   | 11        | net6.0-tizen8.0 | [Link](https://samsung.github.io/TizenFX/API11/) | Tizen 8.0 | [![api11_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API11.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | ![api11_nuget](https://img.shields.io/nuget/v/Tizen.NET.API11.svg)
  14 |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/) |
  15 |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/) |
  16 |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/) |
  17 |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/) |
  18 |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/) |
  19 |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/) |
  20 |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/) |
  21
  22 ### master
  23 The __master__ branch is the main development branch for the Tizen .NET __API Level 12__.
  24
  25 The following NuGet packages will be published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) and [Github Packages Registry](https://github.com/orgs/Samsung/packages?tab=packages&q=Tizen.NET) every day if there are any changes. (Nightly Build)
  26
  27 > - MyGet Feed : ```https://tizen.myget.org/F/dotnet/api/v3/index.json```
  28 > - GitHub Packages Feed : ```https://nuget.pkg.github.com/Samsung/index.json```
  29 >   - GitHub Packages only supports authentication using a personal access token (classic). For more information, see [Working with the NuGet registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry) and [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
  30
  31 * Tizen.NET 12.0.0.#####
  32 * Tizen.NET.API12 12.0.0.#####
  33 * Tizen.NET.Internals 12.0.0.#####
  34
  35 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 next Tizen platform.
  36
  37 ### API4 ~ API11 branches
  38 The __API#__ branches are the release branch for Tizen .NET __API Level #__.
  39
  40 These release branches were __FROZEN__. No new public APIs can be added to these branches, only bug fixes and internal APIs can be added.
  41
  42 ## Using `net6.0-tizen` target framework for API11 or above
  43 If you want to use the `net6.0-tizen` target framework, you need to [install Tizen workload](https://github.com/Samsung/Tizen.NET/wiki/Installing-Tizen-.NET-Workload).
  44
  45 ## Using `tizen` target framework
  46 If you want to use the `tizen` target framework, you need to use `Tizen.NET.Sdk` package as the project sdk.
  47 ```xml
  48 <Project Sdk="Tizen.NET.Sdk/1.1.9">
  49   <PropertyGroup>
  50     <TargetFramework>tizen10.0</TargetFramework>
  51   </PropertyGroup>
  52 </Project>
  53 ```
  54 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).
  55
  56 ### Minimum required versions of Tizen.NET.Sdk and Visual Studio
  57 | API Level | Target Framework | Tizen.NET.Sdk | Visual Studio     |
  58 |:---------:|------------------|---------------|-------------------|
  59 | API12     | net6.0-tizen9.0  | [Tizen .NET Workloads](https://github.com/samsung/Tizen.NET) | 2022       |
  60 | API11     | net6.0-tizen8.0  | [Tizen .NET Workloads](https://github.com/samsung/Tizen.NET) | 2022       |
  61 | API10     | tizen10.0        | 1.1.9         | 2019              |
  62 | API9      | tizen90          | 1.1.7         | 2019              |
  63 | API8      | tizen80          | 1.1.6         | 2019              |
  64 | API7      | tizen70          | 1.0.9         | 2019              |
  65 | API6      | tizen60          | 1.0.9         | 2019              |
  66 | API5      | tizen50          | 1.0.1         | 2017              |
  67 | API4      | tizen40          | 1.0.1         | 2017              |
  68
  69
  70 ## Quick Start
  71 ### Prerequisites
  72 Install .NET Core SDK : https://www.microsoft.com/net/download/
  73
  74 ### Getting the sources
  75 ```bash
  76 git clone https://github.com/Samsung/TizenFX.git
  77 cd TizenFX
  78 ```
  79 ### How to build
  80 ```bash
  81 ./build.sh full
  82 ./build.sh pack
  83 ```
  84
  85 ## Tizen Project
  86 TizenFX is a part of the [Tizen project](https://www.tizen.org).
  87 You can download the latest binaries with TizenFX from the link below :
  88
  89 | Tizen Version     | Link |
  90 |-------------------|------|
  91 | Tizen 4.0         | http://download.tizen.org/snapshots/TIZEN/Tizen-4.0/Tizen-4.0-Unified/latest/ |
  92 | Tizen 5.0         | http://download.tizen.org/snapshots/TIZEN/Tizen-5.0/Tizen-5.0-Unified/latest/ |
  93 | Tizen 5.5         | http://download.tizen.org/snapshots/TIZEN/Tizen-5.5/Tizen-5.5-Unified/latest/ |
  94 | Tizen 6.0         | http://download.tizen.org/snapshots/TIZEN/Tizen-6.0/Tizen-6.0-Unified/latest/ |
  95 | Tizen 6.5         | http://download.tizen.org/snapshots/TIZEN/Tizen-6.5/Tizen-6.5-Unified/latest/ |
  96 | Tizen 7.0         | http://download.tizen.org/snapshots/TIZEN/Tizen-7.0/Tizen-7.0-Unified/latest/ |
  97 | Tizen 8.0         | http://download.tizen.org/snapshots/TIZEN/Tizen-8.0/Tizen-8.0-Unified/latest/ |
  98 | Tizen 9.0         | http://download.tizen.org/snapshots/TIZEN/Tizen/Tizen-Unified/latest          |