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?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  | 7         | tizen70 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext | [![api7_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API7.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | |
13 |API6    | 6         | tizen60 | [Link](https://samsung.github.io/TizenFX/API6/) | Tizen 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) | [![api6_nuget](https://img.shields.io/nuget/v/Tizen.NET.API6.svg)](https://www.nuget.org/packages/Tizen.NET/) |
14 |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/) |
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 7__.
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 7.0.0.#####
22 * Tizen.NET.API7 7.0.0.#####
23 * Tizen.NET.Internals 7.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 (6.0) platform.
26
27 ### API# branches
28 The __API#__ branches are the release branch for Tizen .NET __API Level #__.
29
30 These release branches were __FROZEN__. No new public APIs can be added to these branches, only bug fixes and internal APIs can be added.
31
32 ## Quick Start
33 ### Prerequisites
34 Install .NET Core SDK 2.0+ : https://www.microsoft.com/net/download/
35
36 ### Getting the sources
37 ```bash
38 git clone https://github.com/Samsung/TizenFX.git
39 cd TizenFX
40 ```
41 ### How to build
42 ```bash
43 ./build.sh full
44 ./build.sh pack
45 ```
46
47 ## Tizen Project
48 TizenFX is a part of the [Tizen project](https://www.tizen.org).
49 You can download the latest binaries with TizenFX from the link below :
50
51 | Tizen Version     | Link |
52 |-------------------|------|
53 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
54 | Tizen 5.0         | http://download.tizen.org/snapshots/tizen/5.0-unified/latest/ |
55 | Tizen 5.5         | http://download.tizen.org/snapshots/tizen/5.5-unified/latest/ |
56 | Tizen vNext       | http://download.tizen.org/snapshots/tizen/unified/latest/     |
57