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/workflow/status/Samsung/TizenFX/Build%20Branches/master?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  | 10        | tizen10.0 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext | [![api10_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API10.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) |  |
  13 |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/) |
  14 |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/) |
  15 |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/) |
  16 |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/) |
  17 |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/) |
  18 |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/) |
  19
  20 ### master
  21 The __master__ branch is the main development branch for the Tizen .NET __API Level 10__.
  22
  23 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)
  24 * Tizen.NET 10.0.0.#####
  25 * Tizen.NET.API10 10.0.0.#####
  26 * Tizen.NET.Internals 10.0.0.#####
  27
  28 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.
  29
  30 ### API4,5,6,7,8,9 branches
  31 The __API#__ branches are the release branch for Tizen .NET __API Level #__.
  32
  33 These release branches were __FROZEN__. No new public APIs can be added to these branches, only bug fixes and internal APIs can be added.
  34
  35 ## Using `tizen` target framework
  36 If you want to use the `tizen` target framework, you need to use `Tizen.NET.Sdk` package as the project sdk.
  37 ```xml
  38 <Project Sdk="Tizen.NET.Sdk/1.1.7">
  39   <PropertyGroup>
  40     <TargetFramework>tizen90</TargetFramework>
  41   </PropertyGroup>
  42 </Project>
  43 ```
  44 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).
  45
  46 ### Minimum required versions of Tizen.NET.Sdk and Visual Studio
  47 | API Level | Target Framework | Tizen.NET.Sdk | Visual Studio     |
  48 |:---------:|------------------|---------------|-------------------|
  49 | API10     | tizen10.0        | 1.1.8 (not yet) | 2019            |
  50 | API9      | tizen90          | 1.1.7 (recommend)        | 2019              |
  51 | API8      | tizen80          | 1.1.6         | 2019              |
  52 | API7      | tizen70          | 1.0.9         | 2019              |
  53 | API6      | tizen60          | 1.0.9         | 2019              |
  54 | API5      | tizen50          | 1.0.1         | 2017              |
  55 | API4      | tizen40          | 1.0.1         | 2017              |
  56
  57
  58 ## Quick Start
  59 ### Prerequisites
  60 Install .NET Core SDK : https://www.microsoft.com/net/download/
  61
  62 ### Getting the sources
  63 ```bash
  64 git clone https://github.com/Samsung/TizenFX.git
  65 cd TizenFX
  66 ```
  67 ### How to build
  68 ```bash
  69 ./build.sh full
  70 ./build.sh pack
  71 ```
  72
  73 ## Tizen Project
  74 TizenFX is a part of the [Tizen project](https://www.tizen.org).
  75 You can download the latest binaries with TizenFX from the link below :
  76
  77 | Tizen Version     | Link |
  78 |-------------------|------|
  79 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
  80 | Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
  81 | Tizen 5.5         | http://download.tizen.org/snapshots/tizen/5.5-unified/latest/ |
  82 | Tizen 6.0         | http://download.tizen.org/snapshots/tizen/6.0-unified/latest/ |
  83 | Tizen 6.5         | http://download.tizen.org/snapshots/tizen/unified/latest/     |