Skip to content

Commit

Permalink
Add additional md files (Samsung#100)
Browse files Browse the repository at this point in the history
- Add PULL_REQUEST_TEMPLETE.md
- Add CODE_OF_CONDUCT.md
- Add HOW_TO_MAKE_TIZEN_XAMARIN_FORMS_APP_WITH_CIRCULAR.md
- Add additional info at README.md
  • Loading branch information
jkpu authored and GitHub Enterprise committed Apr 4, 2018
1 parent 1c1c0ce commit 9032fe1
Show file tree
Hide file tree
Showing 11 changed files with 245 additions and 7 deletions.
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at tizenapi@samsung.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
27 changes: 27 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Description of Change ###
Describe your changes here.


### Bugs Fixed ###
- Describe bugs detail information(step to reproduce, version of binary, etc ...) or provide links to bugs here


### API Changes ###
List all API changes here
(or just put None when your changes are only bug fix, behavior change, add/fix testcase, add/fix sample), example:

Added:
- Add CircleStackLayout
- Add add LabelFormat property at CircleStepper
public string LabelFormat

Changed:
- Change name of Color property
public Color Color => public Color MarkerColor

Removed:
- Remove popup style at Check

### Behavioral Changes ###
Describe any non-bug related behavioral changes that may change how users app behaves when upgrading to this version of the codebase.

39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,52 @@
# Tizen CircularUI

The Tizen CircularUI is a set of helpful extensions to the Xamarin Forms framework on the Samsung Gear device.
The banaries are available via NuGet (package name CircularUI) with the source available at here.
[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)


- [Introduction](#introduction)
- [Controls](#controls)
- [Prerequisite](#prerequisite)
- [How to use CircularUI](#how-to-use-circularui)

## Introduction
The Tizen CircularUI project is a set of helpful extensions of the Xamarin Forms framework.<br>
The aim of the Tizen CircularUI project is to develop an open source software motivate software developer to creating Tizen Wearable Xamarin Forms app more easily and efficiently.<br>
The binaries are available via NuGet (package name CircularUI)<br>

_Xamarin Forms provides cross-platform APIs, but this project are only worked on the Samsung Gear device that support Tizen .NET._


## Controls
The Tizen CircularUI project provides you the following UI controls:

- CirclePage : A subclass of Xamarin.Forms.Page that can shows Circlular ProgressBar and Circular Slider and the button on bottom of screen. it can also show MenuItems on the circular menu.(MoreOption)
- CircleListView : A subclass of Xamarin.Forms.ListView control fits in the circular screen.
- CirclePage : A subclass of Xamarin.Forms.Page that can show circular ProgressBar and circular Slider and Button on bottom of screen. it can also show MenuItems on the circular menu.(MoreOption)
- CircleListView : A subclass of Xamarin.Forms.ListView control fits in the circular screen and have circular scroll bar.
- CircleProgressBarSurfaceItem : A control fits in the circular screen. it can be shown in CirclePage only.
- CircleSliderSurfaceItem : A Slider control that responds to the bezel action and fits in the circular screen.
- CircleScrollView : A subclass of Xamarin.Forms.ScrollView that can be scrolled by the bezel action.
- CircleDateTimeSelector : A control to select date or time fits in the circular screen.
- CircleStepper : A control to select a number of steps fits in the circular screen.
- CircleStackLayout : A container to layout children linear in the circular area.
- IndexPage : A subclass of multiple page that can slide child page horizontal and has dots on top of the screen for the number of child pages.
- Check : A subclass of Xamarin.Forms.Switch control with some different styles.
- Check : A subclass of Xamarin.Forms.Switch control supports tizen specific style.
- RotationReceiver : A event receiver for using the bezel action.
- Radio : A radio control fits in the circular screen.
- Radio : A radio control.
- Toast : A popup for simple feedback.
- TwoButtonPage : A subclass of Xamarin.Forms.Page has two button in left and right side of the circular screen.
- ContextPopup : A context popup fits in the circular screen.
- ConfirmationPopup : A popup has two button in left and right side of the circular screen.
- ConfirmPopupEffect : the effect to show a small popup has one or two button sticky with any control.
- InformationPopup : A popup has a control to show progress and one button in bottom side of circular screen.

![widgets](doc/design/data/widgets.png)
![widgets](doc/design/data/widgets.png)

## Prerequisite
- Visual Studio 2017
- Visual Studio Tools for Tizen
- [How to install Visual Studio Tools for Tizen](https://developer.tizen.org/development/visual-studio-tools-tizen/installing-visual-studio-tools-tizen)
- Installing Tizen Wearable emulator image (WEARABLE-4.0-Emulator or WEARABLE-5.0-Emulator)

## How to use CircularUI
- [How to make Tizen Wearable Xamarin Forms App with CircularUI](doc/guide/HOW_TO_MAKE_TIZEN_XAMARIN_FORMS_APP_WITH_CIRCULARUI.md)

- The [API Reference](https://github.sec.samsung.net/pages/dotnet/apidoc/XamarinFormsCircularUI/api/index.html) is available on the web to browse.
140 changes: 140 additions & 0 deletions doc/guide/HOW_TO_MAKE_TIZEN_XAMARIN_FORMS_APP_WITH_CIRCULARUI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# How to make Tizen Xamarin Forms App with CircularUI

- Create Tizen Xamarin Forms App following to [Tizen.org guide](https://developer.tizen.org/development/training/.net-application/creating-your-first-tizen-.net-application).
In this guide project name is `SampleCircleApp`



- Select only wearable device at tizen project wizard.<br>
![wizard](data/tizen_project_wizard_capture.png)



- Search Tizen.CircularUI nuget pakage at Nuget package manager.<br>
![nuget](data/nuget_package_manager_capture.png)



- Install Tizen.CircularUI nuget at portable class library(PCL) project.<br>
![pcl](data/after_Install_nuget_package.png)



- remove SampleCircleApp.cs that is generated automatically at PCL. and then add App.xaml and App.xaml.cs using add item.

- Insert code at App.xaml.cs

```
using CircularUI;
using System;
using Xamarin.Forms;
using Xamarin.Forms.Xaml;
namespace SampleCircleApp
{
internal static class WidgetName
{
public const string Slider = "slider";
public const string Progress = "progress";
}
[XamlCompilation(XamlCompilationOptions.Compile)]
public partial class App : Application
{
public App()
{
InitializeComponent();
}
public void OnButtonClicked(object sender, EventArgs e)
{
Toast.DisplayText("Toast popup", 3000);
}
}
}
```



- Insert xaml code at App.xaml file

```
<?xml version="1.0" encoding="utf-8" ?>
<Application
x:Class="SampleCircleApp.App"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:local="clr-namespace:SimpleCircleApp"
xmlns:w="clr-namespace:CircularUI;assembly=CircularUI">
<Application.MainPage>
<NavigationPage x:Name="MainNavigation">
<x:Arguments>
<w:CirclePage
x:Name="page"
NavigationPage.HasNavigationBar="False"
RotaryFocusTargetName="slider">
<w:CirclePage.Content>
<StackLayout
HorizontalOptions="Center"
Orientation="Vertical"
VerticalOptions="Center">
<Label HorizontalTextAlignment="Center" Text="Welcome to Xamarin Forms!" />
<Button Clicked="OnButtonClicked" Text="show toast" />
</StackLayout>
</w:CirclePage.Content>
<w:CirclePage.CircleSurfaceItems>
<w:CircleSliderSurfaceItem
x:Name="slider"
Increment="0.5"
IsVisible="True"
Maximum="15"
Minimum="0"
Value="3" />
</w:CirclePage.CircleSurfaceItems>
</w:CirclePage>
</x:Arguments>
</NavigationPage>
</Application.MainPage>
</Application>
```



- Insert `CircularUI.Init()` code in Main method at SampleCircleApp.Tizen.Wearable.cs

```
static void Main(string[] args)
{
var app = new Program();
global::Xamarin.Forms.Platform.Tizen.Forms.Init(app);
CircularUI.Tizen.CircularUI.Init(); //must insert this initialize code
app.Run(args);
}
```



- Build the solution.

- Launch Tizen Emulator <br>
![launchEmul1](data/launch_emulator1.png)

![launchEmul2](data/launch_emulator2.png)



- If your OS is window, launch Tizen Sdb Command Prompt(Tool > Tizen > Tizen Sdb Command Prompt).
If you use Linux. you can use sdb command directly in your project path.

- Install your app with sdb command

```
sdb install org.tizen.example.SampleCircleApp.Tizen.Wearable-1.0.0.tpk
```


- check your App at Wearable emulator<br>
![launchApp](data/launch_app.png)<br>

![appCapture1](data/app_capture1.png)<br>
Binary file added doc/guide/data/after_Install_nuget_package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guide/data/app_capture1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guide/data/launch_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guide/data/launch_emulator1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guide/data/launch_emulator2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/guide/data/tizen_project_wizard_capture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9032fe1

Please sign in to comment.