Merge remote-tracking branch 'origin/master' into tizen
[platform/core/csapi/tizenfx.git] / 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 Xamarin.Forms 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 ## Quick Start
36 ### Prerequisites
37 Install .NET Core SDK : https://www.microsoft.com/net/download/
38
39 ### Getting the sources
40 ```bash
41 git clone https://github.com/Samsung/TizenFX.git
42 cd TizenFX
43 ```
44 ### How to build
45 ```bash
46 ./build.sh full
47 ./build.sh pack
48 ```
49
50 ## Tizen Project
51 TizenFX is a part of the [Tizen project](https://www.tizen.org).
52 You can download the latest binaries with TizenFX from the link below :
53
54 | Tizen Version     | Link |
55 |-------------------|------|
56 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
57 | Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
58 | Tizen 5.5         | http://download.tizen.org/snapshots/tizen/5.5-unified/latest/ |
59 | Tizen 6.0         | http://download.tizen.org/snapshots/tizen/6.0-unified/latest/ |
60 | Tizen 6.5         | http://download.tizen.org/snapshots/tizen/unified/latest/     |