Update README.md (#1)
[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
5 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.
6
7 ## Contents
8 > [Branches of TizenFX](#branches)  
9 > [Quick Start](#quick-start)  
10 > [Tizen Project](#tizen-project)
11
12 ## Branches
13
14 | branch | API level | pre-release | stable |
15 |--------|:---------:|-------------|--------|
16 |master  | 5         | [![api5_myget](https://img.shields.io/tizen.myget/dotnet/vpre/Tizen.NET.API5.svg)](https://tizen.myget.org/feed/dotnet/package/nuget/Tizen.NET) | |
17 |API4    | 4         | [![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/) |
18
19 ### master
20 The __master__ branch is the main development branch for the Tizen .NET __API Level 5__.
21
22 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) 
23 * Tizen.NET-5.0.0-preview1-xxxxx
24 * Tizen.NET.API5-5.0.0.xxxxx
25 * Tizen.NET.Internals-5.0.0.xxxxx
26
27 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 5.0 platform.
28
29 ### API4
30 The __API4__ branch is the release branch for Tizen .NET __API Level 4__. 
31
32 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.
33
34 The following NuGet packages are published to [Tizen MyGet Gallery](https://tizen.myget.org/gallery/dotnet) on demand.
35 * Tizen.NET-4.0.1-preview1-xxxxx
36 * Tizen.NET.API4-4.0.1.xxxxx
37 * Tizen.NET.Internals-4.0.1.xxxxx
38
39 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.
40
41
42
43 ## Quick Start
44 ### Getting the sources
45 ```bash
46 git clone https://github.com/Samsung/TizenFX.git
47 cd TizenFX
48 ```
49 ### How to build
50 ```bash
51 ./build.sh full
52 ./build.sh pack 
53 ```
54
55
56 ## Tizen Project
57 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).  
58 You can download the latest binaries with TizenFX from the link below :  
59
60 | Tizen Version | Link |
61 |---------------|------|
62 | Tizen 4.0     | http://download.tizen.org/snapshots/tizen/4.0-unified/latest/ |
63 | Tizen vNext   | http://download.tizen.org/snapshots/tizen/unified/latest/ |
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81