b39130a49f2f0e882248f5348e7f219a9f8c8797
[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
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 ## Contents
9 > [Branches of TizenFX](#branches)  
10 > [Quick Start](#quick-start)  
11 > [Tizen Project](#tizen-project)
12
13 ## Branches
14
15 | branch | API level | platform          | myget.org | nuget.org  |
16 |--------|:---------:|-------------------|-------------|--------|
17 |master  | 5         | 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) | |
18 |API4    | 4         | 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/) |
19
20 ### master
21 The __master__ branch is the main development branch for the Tizen .NET __API Level 5__.
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-5.0.0.#####
25 * Tizen.NET.API5-5.0.0.#####
26 * Tizen.NET.Internals-5.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 submmited for the Tizen vNext (5.0) platform.
29
30 ### API4
31 The __API4__ branch is the release branch for Tizen .NET __API Level 4__. 
32
33 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.
34
35 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
36 * Tizen.NET-4.0.1.#####
37 * Tizen.NET.API4-4.0.1.#####
38 * Tizen.NET.Internals-4.0.1.#####
39
40 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 submmited for the Tizen 4.0 platform.
41
42
43
44 ## Quick Start
45 ### Prerequisites
46 Install .NET Core SDK 2.0+ : https://www.microsoft.com/net/download/
47
48 ### Getting the sources
49 ```bash
50 git clone https://github.com/Samsung/TizenFX.git
51 cd TizenFX
52 ```
53 ### How to build
54 ```bash
55 ./build.sh full
56 ./build.sh pack 
57 ```
58
59
60 ## Tizen Project
61 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).  
62 You can download the latest binaries with TizenFX from the link below :  
63
64 | Tizen Version     | Link |
65 |-------------------|------|
66 | Tizen 4.0         | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
67 | Tizen vNext (5.0) | http://download.tizen.org/snapshots/tizen/unified/latest/ |
68
69