Release 6.0.0.14593
[platform/core/csapi/tizenfx.git] / README.md
1 # TizenFX
2
3 [![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)
4 [![Build Status](http://13.124.0.26:8080/buildStatus/icon?job=TizenFX/Branch_Checkers/master)](http://13.124.0.26:8080/job/TizenFX/job/Branch_Checkers/job/master/)
5
6
7 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.
8
9 ## Branches
10
11 | Branch | API Level | Target Framework | API Reference | Platform          | myget.org | nuget.org  |
12 |--------|:---------:|------------------|---------------|-------------------|-----------|------------|
13 |master  | 6         | tizen60 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext (5.5) | [![api6_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API6.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | |
14 |API5    | 5         | tizen50 | [Link](https://samsung.github.io/TizenFX/master/) | 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/) |
15 |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/) |
16
17 ### master
18 The __master__ branch is the main development branch for the Tizen .NET __API Level 6__.
19
20 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)
21 * Tizen.NET-6.0.0.#####
22 * Tizen.NET.API6-6.0.0.#####
23 * Tizen.NET.Internals-6.0.0.#####
24
25 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 (5.5) platform.
26
27 ### API5
28 The __API5__ branch is the release branch for Tizen .NET __API Level 5__.
29
30 The API Level 5 was __FROZEN__. No new public APIs can be added to this branch, only bug fixes and internal APIs can be added.
31
32 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
33 * Tizen.NET-5.0.0.#####
34 * Tizen.NET.API5-5.0.0.#####
35 * Tizen.NET.Internals-5.0.0.#####
36
37 And, This branch is pushed to the [tizen_5.0 branch](https://git.tizen.org/cgit/platform/core/csapi/tizenfx/?h=tizen_5.0) in the tizen gerrit and submitted for the Tizen 5.0 platform.
38
39 ### API4
40 The __API4__ branch is the release branch for Tizen .NET __API Level 4__.
41
42 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.
43
44 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
45 * Tizen.NET-4.0.1.#####
46 * Tizen.NET.API4-4.0.1.#####
47 * Tizen.NET.Internals-4.0.1.#####
48
49 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 submitted for the Tizen 4.0 platform.
50
51
52
53 ## Quick Start
54 ### Prerequisites
55 Install .NET Core SDK 2.0+ : https://www.microsoft.com/net/download/
56
57 ### Getting the sources
58 ```bash
59 git clone https://github.com/Samsung/TizenFX.git
60 cd TizenFX
61 ```
62 ### How to build
63 ```bash
64 ./build.sh full
65 ./build.sh pack
66 ```
67
68
69 ## Tizen Project
70 TizenFX is a part of the [Tizen project](https://www.tizen.org).
71 You can download the latest binaries with TizenFX from the link below :
72
73 | Tizen Version     | Link |
74 |-------------------|------|
75 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
76 | Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
77 | Tizen vNext (5.5) | http://download.tizen.org/snapshots/tizen/unified/latest/ |
78
79