Merge remote-tracking branch 'origin/API6' into tizen_5.5
[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](https://travis-ci.org/Samsung/TizenFX.svg?branch=master)](https://travis-ci.org/Samsung/TizenFX)
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  | 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) | |
13 |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/) |
14 |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/) |
15
16 ### master
17 The __master__ branch is the main development branch for the Tizen .NET __API Level 6__.
18
19 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)
20 * Tizen.NET-6.0.0.#####
21 * Tizen.NET.API6-6.0.0.#####
22 * Tizen.NET.Internals-6.0.0.#####
23
24 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.
25
26 ### API5
27 The __API5__ branch is the release branch for Tizen .NET __API Level 5__.
28
29 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.
30
31 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
32 * Tizen.NET-5.0.0.#####
33 * Tizen.NET.API5-5.0.0.#####
34 * Tizen.NET.Internals-5.0.0.#####
35
36 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.
37
38 ### API4
39 The __API4__ branch is the release branch for Tizen .NET __API Level 4__.
40
41 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.
42
43 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
44 * Tizen.NET-4.0.1.#####
45 * Tizen.NET.API4-4.0.1.#####
46 * Tizen.NET.Internals-4.0.1.#####
47
48 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.
49
50
51
52 ## Quick Start
53 ### Prerequisites
54 Install .NET Core SDK 2.0+ : https://www.microsoft.com/net/download/
55
56 ### Getting the sources
57 ```bash
58 git clone https://github.com/Samsung/TizenFX.git
59 cd TizenFX
60 ```
61 ### How to build
62 ```bash
63 ./build.sh full
64 ./build.sh pack
65 ```
66
67
68 ## Tizen Project
69 TizenFX is a part of the [Tizen project](https://www.tizen.org).
70 You can download the latest binaries with TizenFX from the link below :
71
72 | Tizen Version     | Link |
73 |-------------------|------|
74 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
75 | Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
76 | Tizen vNext (5.5) | http://download.tizen.org/snapshots/tizen/unified/latest/ |
77
78