Merge remote-tracking branch 'github/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](http://13.124.0.26:8080/buildStatus/icon?job=TizenFX/API5_Build_Checker)](http://13.124.0.26:8080/job/TizenFX/job/API5_Build_Checker/)
5 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/90e062a552024a1c94e3ffeeae946f65)](https://www.codacy.com/app/tizenapi/TizenFX?utm_source=github.com&utm_medium=referral&utm_content=Samsung/TizenFX&utm_campaign=Badge_Grade)
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 ## Contents
10 > [Branches of TizenFX](#branches)  
11 > [Quick Start](#quick-start)  
12 > [Tizen Project](#tizen-project)
13
14 ## Branches
15
16 | Branch | API Level | Target Framework | API Reference | Platform          | myget.org | nuget.org  |
17 |--------|:---------:|------------------|---------------|-------------------|-----------|------------|
18 |master  | 5         | tizen50 | [Link](https://samsung.github.io/TizenFX/master/) | Tizen vNext (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) | |
19 |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.svg)](https://www.nuget.org/packages/Tizen.NET/) |
20
21 ### master
22 The __master__ branch is the main development branch for the Tizen .NET __API Level 5__.
23
24 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) 
25 * Tizen.NET-5.0.0.#####
26 * Tizen.NET.API5-5.0.0.#####
27 * Tizen.NET.Internals-5.0.0.#####
28
29 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.0) platform.
30
31 ### API4
32 The __API4__ branch is the release branch for Tizen .NET __API Level 4__. 
33
34 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.
35
36 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
37 * Tizen.NET-4.0.1.#####
38 * Tizen.NET.API4-4.0.1.#####
39 * Tizen.NET.Internals-4.0.1.#####
40
41 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.
42
43
44
45 ## Quick Start
46 ### Prerequisites
47 Install .NET Core SDK 2.0+ : https://www.microsoft.com/net/download/
48
49 ### Getting the sources
50 ```bash
51 git clone https://github.com/Samsung/TizenFX.git
52 cd TizenFX
53 ```
54 ### How to build
55 ```bash
56 ./build.sh full
57 ./build.sh pack 
58 ```
59
60
61 ## Tizen Project
62 TizenFX is a part of the [Tizen project](https://www.tizen.org) and has been officially included since [4.0 M2 release](https://www.tizen.org/blogs/tsg/2017/tizen-4.0-m2-source-code-release).  
63 You can download the latest binaries with TizenFX from the link below :  
64
65 | Tizen Version     | Link |
66 |-------------------|------|
67 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
68 | Tizen vNext (5.0) | http://download.tizen.org/snapshots/tizen/unified/latest/ |
69
70