diff --git a/README.md b/README.md index ff58fb83..cc9cb186 100644 --- a/README.md +++ b/README.md @@ -4,67 +4,3 @@ Made with [contrib.rocks](https://contrib.rocks). -# Development Guide -- Repo template: [Chick and Paddy MAUI template](https://github.com/tuyen-vuduc/chick-and-paddy-dotnet-maui) -- Coding guidelines: [Naxam coding guidelines and pactices](https://github.com/NAXAM/guidelines-n-practices) - -# How to create demo page for a control - -## The steps -- Create a folder under `Gallery/Pages/{control-group}` - - folder name must be the control name - - control group can be BuiltIn, Syncfusion, etc. -- Create - - a ControlInfo class - - a XAML page - - a VM class - -e.g A demo page for Button built-in control will have below structure -``` -| -|--Features - |--Gallery - |--Pages - |--Button - |--ButtonControlInfo - |--ButtonPage.xaml - |--ButtonPage.xaml.cs - |--ButtonPageViewModel.cs -``` - -class diagram -```mermaid -classDiagram - ButtonPage ..|> IControlPage: declares - BasePage <|-- ButtonPage: extends - ButtonControlInfo ..|> IControlInfo: declares - NavigationAwareBaseViewModel <|-- ButtonPageViewModel: extends - ButtonPage o-- ButtonPageViewModel: BindingContext - ButtonPage .. ButtonControlInfo: route name - - class IControlInfo - <> IControlInfo - class IControlPage - <> IControlPage - class NavigationAwareBaseViewModel - <> NavigationAwareBaseViewModel - class BasePage - <> BasePage - class ButtonPage - class ButtonControlInfo - class ButtonPageViewModel -``` - -## Use script - -``` -dotnet cake --group DESIRE_GROUP --name CONTROL_NAME --cardDetail CARD_DETAIL --originalDocumentUrl URL -``` - -### Available groups -- `BuiltIn` - [MAUI built-in controls](https://learn.microsoft.com/en-us/dotnet/maui/user-interface/controls/?view=net-maui-7.0) -- `Syncfusion` - [Syncfusion controls for MAUI](https://www.syncfusion.com/maui-controls) -- `CardDetail` - Provde detail information for this card ℹ️ -- `OriginalDocumentUrl` - Provide the card original documentation📄 - -NOTE: We can add any new group we want.