Skip to content

Commit 79b8d3b

Browse files
DevTKSSDevTKSS
committed
docs(README): Rework the Readme
1 parent 1559ce9 commit 79b8d3b

File tree

1 file changed

+88
-49
lines changed

1 file changed

+88
-49
lines changed

‎README.md‎

Lines changed: 88 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,129 @@
11
# DevTKSS Uno Samples
22

3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/blob/master/LICENSE.md)
4+
[![Documentation](https://img.shields.io/badge/docs-online-green.svg)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/)
5+
[![Uno Platform](https://img.shields.io/badge/Uno%20Platform-5.5+-purple.svg)](https://platform.uno/)
6+
37
## Welcome to this Samples and Tutorials Library! ❤️
48

5-
The here contained samples and Tutorials are meant to help Developers, independent to their pre-knowledge, to get an Idea of:
9+
This is a collection of Sample Apps and Tutorials for the [Uno Platform](https://platform.uno/), created to fill the gap of missing **German-localized** learning content. Most tutorials are available in both **German** (primary) and **English**.
610

7-
- How to get started with the [Uno Platform](https://platform.uno/)
8-
- How the Sampled Features and Controls can be used inside of our Applications
11+
**Quick Links:** [Get Started](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/HowTo-Setup-DevelopmentEnvironment-en.html) | [Documentation](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/) | [Video Tutorials (German)](https://youtube.com/playlist?list=PLEL6kb4Bivm_g81iKBl-f0eYPNr5h2dFX) | [Discussions](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/discussions)
12+
13+
---
14+
15+
## About This Repository
916

10-
This is a collection of Sample Apps and Tutorials for the [Uno Platform](https://platform.uno/), aiming to fill the gap of missing ***German Localized*** learning Content.
17+
This repository aims to help developers, regardless of their prior knowledge, learn:
1118

12-
### Page - Table of Contents
19+
- How to get started with the [Uno Platform](https://platform.uno/)
20+
- How to use featured controls and patterns in real applications
21+
- Best practices for MVUX, Navigation, and other Uno.Extensions
1322

14-
- **Samples in this Repository:**
15-
- [Mvux Gallery](#mvux-gallery)
16-
- [XamlNavigationApp](#xaml-navigation-app)- Localized Tutorial available in German!
23+
### Prerequisites
1724

18-
- [**Tutorials**](#tutorial-videos-and-used-samples)
25+
Before diving into the samples, make sure you have:
1926

20-
- [Feedback, Issues and Contributing](#feedback-issues-and-contributing)
27+
- **.NET 9.0 SDK** or later
28+
- **Visual Studio 2022** (17.8+) with Uno Platform extension, **Rider**, or **VS Code**
29+
- **Uno.Check** tool installed and verified (run `uno-check`)
2130

2231
> [!TIP]
23-
> Check out the [Documentation & Tutorials](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/), for more a more detailed List and future coming Guides and Explanations.
32+
> For detailed setup instructions, see our [Development Environment Setup Guide](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/HowTo-Setup-DevelopmentEnvironment-en.html).
33+
34+
---
2435

25-
## Mvux Gallery
36+
## Sample Applications
37+
38+
### Mvux Gallery
2639

2740
![Mvux Gallery Showcase Thumbnail](./doc/articles/.attachments/DevTKSS%20Uno%20Mvux%20Samples%20Gallery%20App-Thumbnail.png)
2841

29-
**Wanna see a quick showcase, what to explore there?**
42+
**Want to see a quick showcase of what you can explore?**
3043

3144
![Mvux Gallery ShowCase](./doc/articles/.attachments/MvuxGallery-ShowCase.gif)
3245

33-
Following list provides you a quick Overview, what you can find in the [Mvux Gallery](./src/DevTKSS.Uno.Samples.MvuxGallery/) App.
34-
[Detailed and linked Overview about the Mvux Gallery Contents](./doc/articles/de/MvuxGallery-Overview.md)
46+
The [Mvux Gallery](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/tree/master/src/DevTKSS.Uno.Samples.MvuxGallery/) demonstrates modern Uno Platform development patterns with a comprehensive example application.
3547

36-
### Sampled Controls
48+
**[View Detailed Mvux Gallery Overview](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/MvuxGallery-Overview-en.html)**
3749

38-
- FeedView combined with:
39-
- GridView
40-
- ListView
41-
- DataTemplate centralized Resource definition
42-
- Card
43-
- Grid
44-
- NavigationView
45-
- `ItemOverlayTemplate` DataTemplate layout replicated from WinUI 3 Gallery
46-
- TabBar & TabBarItem
50+
#### Featured Controls
4751

48-
### Sampled Uno.Extensions
52+
- **FeedView** combined with GridView and ListView
53+
- **DataTemplate** centralized resource definitions
54+
- **Card**, **Grid**, **NavigationView**
55+
- **ItemOverlayTemplate** (replicated from WinUI 3 Gallery)
56+
- **TabBar & TabBarItem**
4957

50-
- [Mvux](./src/DevTKSS.Uno.Samples.MvuxGallery/Presentation/ViewModels/ListboardModel.cs)
51-
- Navigation
52-
- [via Xaml](./src/DevTKSS.Uno.Samples.MvuxGallery/doc/articles/en/Navigation/HowTo-Defining-UI-NavigationView-en.md)
53-
- Hosting (App Host Builder)
54-
- Dependency Injection
55-
- Serialization
56-
- Configuration
57-
- Data for Serialization load from separate [`appsettings.sampledata.json`](./src/DevTKSS.Uno.Samples.MvuxGallery/master/appsettings.sampledata.json) file.
58-
- Storage
59-
- Localization
58+
#### Demonstrated Uno.Extensions
6059

61-
### Known Issues on the Mvux Gallery
60+
- **[MVUX](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Mvux/Overview.html)** - Model-View-Update-eXtended pattern
61+
- **Navigation**
62+
- [Navigation via XAML](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/Navigation/HowTo-Defining-UI-NavigationView-en.html)
63+
- [React to Route Changes with IRouteNotifier](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/Navigation/HowTo-ChangeRoutes-en.html)
64+
- **Hosting** - App Host Builder pattern
65+
- **Dependency Injection** - Constructor injection
66+
- **Serialization** - JSON data handling
67+
- **Configuration** - Data loaded from `appsettings.json`
68+
- **Storage** - Local data persistence
69+
- **Localization** - Multi-language support
6270

63-
- [ ] [ThemeResource Styled are not listening to Theme changes](https://github.com/DevTKSS/DevTKSS.Uno.Samples.MvuxGallery/issues/13)
64-
- [ ] docfx fails to resolve source code links for e.g. included code snippets
71+
#### Known Issues
6572

66-
## Tutorial Videos and used Samples
73+
- ThemeResource styles are not listening to theme changes ([Issue #13](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/issues/13))
74+
- DocFX fails to resolve source code links for included code snippets
6775

68-
To show you how to get to the end result of the Mvux Gallery App, I created a Tutorial Video that will guide you through the process of building this App with the following Sample Apps and added Documentation.
76+
---
6977

7078
### Xaml Navigation App
7179

7280
![Image of final Xaml Navigation App](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/blob/master/doc/articles/.attachments/DevTKSS.Uno.XamlNavigationApp.png)
7381

74-
#### Content of the Tutorial
82+
A complete tutorial application demonstrating navigation patterns with MVUX and XAML.
83+
84+
#### Tutorial Content
7585

76-
- [Uno.Extensions.Reactive also known as `Mvux`](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Mvux/Overview.html)
86+
- [Uno.Extensions.Reactive (MVUX)](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Mvux/Overview.html)
7787
- [Uno.Extensions.Navigation](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Navigation/NavigationOverview.html)
78-
- [Xaml Markup Navigation](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Navigation/HowTo-NavigateInXAML.html)
88+
- [XAML Markup Navigation](https://platform.uno/docs/articles/external/uno.extensions/doc/Learn/Navigation/HowTo-NavigateInXAML.html)
7989

80-
[Discover the Source Code of the DevTKSS.Uno.XamlNavigationApp](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/blob/master/src/DevTKSS.Uno.XamlNavigationApp-1/)
90+
**Available Resources:**
91+
92+
- **[Tutorial Documentation](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/Navigation/Extensions-Navigation-en.html)** - Step-by-step guide (🇩🇪 German | 🇬🇧 English)
93+
- **[Video Tutorial Series](https://youtube.com/playlist?list=PLEL6kb4Bivm_g81iKBl-f0eYPNr5h2dFX)** - Complete walkthrough (🇩🇪 German with English subtitles)
94+
- **[Source Code](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/tree/master/src/DevTKSS.Uno.XamlNavigationApp-1/)** - Browse the implementation
95+
96+
---
97+
98+
## Documentation & Tutorials
99+
100+
You can access all tutorials and guides in both English and German. Use the table below to quickly jump to the documentation in your preferred language:
101+
102+
| Section | English | German |
103+
|--------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------|
104+
| Getting Started | [Guide (EN)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/HowTo-Setup-DevelopmentEnvironment-en.html) | [Anleitung (DE)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/de/HowTo-Setup-DevelopmentEnvironment-de.html) |
105+
| Mvux Gallery Overview | [Overview (EN)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/MvuxGallery-Overview-en.html) | [Übersicht (DE)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/de/MvuxGallery-Overview-de.html) |
106+
| Navigation Tutorials | [Navigation (EN)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/en/Navigation/Extensions-Navigation-en.html) | [Navigation (DE)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/articles/de/Navigation/Extensions-Navigation-de.html) |
107+
| All Docs Index | [Docs Home (EN)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/) | [Docs Home (DE)](https://devtkss.github.io/DevTKSS.Uno.SampleApps/doc/index.html?lang=de) |
108+
109+
Most content is available in both German (original) and English (translated).
110+
111+
---
81112

82113
## Feedback, Issues and Contributing
83114

84-
Let me know if you have any questions or feedback!
115+
We welcome your feedback and contributions!
116+
117+
- **Questions?** Start a [Discussion](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/discussions)
118+
- **Found a bug?** Open an [Issue](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/issues)
119+
- **Want to contribute?** Check out our [Contributing Guidelines](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/blob/master/CONTRIBUTING.md)
120+
- **Have an idea?** Share it in [Discussions](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/discussions/new)
85121

86-
If you find any issues or have suggestions for improvements, please open an [issue](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/issues) or [discussion](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/discussions).
122+
---
87123

88-
In case you want to contribute, check out the [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get started.
124+
### Helpful Resources
89125

90-
You are missing a feature or have an idea for a new Sample App? Please open a [discussion](https://github.com/DevTKSS/DevTKSS.Uno.SampleApps/discussions/new) to share your thoughts!
126+
- [Uno Platform Homepage](https://platform.uno/)
127+
- [Uno Platform Documentation](https://platform.uno/docs/articles/intro.html)
128+
- [Uno Platform Discord Community](https://discord.gg/eBHZSKG)
129+
- [Uno Platform on GitHub](https://github.com/unoplatform/uno)

0 commit comments

Comments
 (0)