documentation : framework

README.md

 # UI Widgets
 
-## Development
-1. Start **Unity(2018.3 or above)**, create a local empty project.
-   
-1. In a console (or terminal) application, go to the newly created project folder, then clone this repo into the packages directory.
+## Introduction
-    ```none
+
+## Requirement
+
+#### Unity
+Install **Unity 2018.3** or above. You can download the latest Unity on https://unity3d.com/get-unity/download.
+
+#### UIWidget Package
+Visit our Github repository https://gitlab.cds.internal.unity3d.com/upm-packages/ui-widgets/com.unity.uiwidgets.git
+ to download the latest UIWidget package.
+ 
+Move the downloaded package folder into the **Package** folder of your Unity project.
+
+Generally, you can make it using a console (or terminal) application by just a few commands as below:
+    
+   ```none
-    ```
+   ```
+## Getting Start
-## Code Style
+#### i. Overview
+
+#### ii. Scene Build
+
+#### iii. Create Widget
+
+#### iv. Build App
+
+#### v. Move to Editor
+
+## Learn
+#### Samples
+
+#### Wiki
+
+
+## Contribute
+
+
+#### Code Style
 1. **Import the Customized Code Cleanup Settings**: Open Preferences -> Manage Layers, 
 Choose 'Solution "\<YourProjectName\>" personal' and Click "Add Layer" ("+") -> "Open Settings File...".
 and Open the file "UIWidgetCleanupPlugin.DotSettings" under \<YourProjectPath\>/Packages/com.unity.uiwidgets/"
 
 3. **Refine Code Style Rules**: Edit the ".editorconfig" file under \<YourProjectPath\>/Packages/com.unity.uiwidgets/". Visit
  https://www.jetbrains.com/help/rider/EditorConfig_Index.html for the detailed.
- 
-REF: https://www.jetbrains.com/help/rider/Sharing_Configuration_Options.html
+