Skip to content

Commit bc79326

Browse files
Merge pull request #1 from sanjayvikramsf4373/Update_ReadMefile
Update the read me file for winui analog clock UI example
2 parents d01aef9 + 67b8e96 commit bc79326

1 file changed

Lines changed: 45 additions & 1 deletion

File tree

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
11
# WinUI-Analog-Clock-UI
2-
This repository holds the project for the analog clock UI developed in WinUI
2+
3+
This repository contains a compact, self-contained WinUI-based analog clock user interface implemented as a sample desktop application.
4+
5+
Overview
6+
---------
7+
`WinUI-Analog-Clock-UI` demonstrates building a modern, analog clock using WinUI and .NET. The project focuses on clean XAML layout, vector assets, and time-driven rendering so the clock remains visually sharp across DPI settings and window sizes.
8+
9+
Key Features
10+
------------
11+
- Crisp vector-based clock face and hands that scale smoothly with window size and DPI.
12+
- Smooth, time-accurate hand movement driven by a background timer.
13+
- Simple asset structure under the `Assets/` folder for easy replacement of icons, backgrounds, and face elements.
14+
- Minimal, easy-to-follow XAML and code-behind in `MainWindow.xaml` and `MainWindow.xaml.cs` so developers can adapt the UI quickly.
15+
16+
Requirements
17+
------------
18+
- Windows 10 (version 19041 or later) or Windows 11.
19+
- .NET 6 SDK (or matching target framework used by the project).
20+
- Visual Studio 2022 or later with the Universal Windows Platform / WinUI workload recommended for development and debugging.
21+
22+
Syncfusion WinUI RadialGauge
23+
----------------------------
24+
This sample uses the Syncfusion WinUI radial gauge control (`SfRadialGauge`) to render the clock face and hands. The gauge is referenced in `MainWindow.xaml` via the `Syncfusion.UI.Xaml.Gauges` namespace and provides the `SfRadialGauge`, `RadialAxis`, and `NeedlePointer` primitives used by the UI.
25+
26+
To build this project, add the Syncfusion WinUI Gauges package to the project via NuGet (or your preferred package manager) and ensure any required Syncfusion runtime registration or license steps are completed. Syncfusion controls are provided under Syncfusion's licensing terms — for evaluation or free community use, consult Syncfusion's website for details and registration instructions.
27+
28+
Build and Run
29+
-------------
30+
1. Open the solution in Visual Studio: open `AnalogClockUI.sln`.
31+
2. Restore NuGet packages (Visual Studio typically does this automatically).
32+
3. Build the solution and run using the debugger or run `dotnet build` from the solution folder and then launch the generated executable for the `net6.0-windows` target.
33+
34+
Customization
35+
-------------
36+
Replace vector assets in the `Assets/` folder to change the appearance of the clock face or hands. Adjust rendering and timing logic in `MainWindow.xaml.cs` if you need different behavior (for example, ticking vs. smooth sweep).
37+
38+
Contributing
39+
------------
40+
Contributions are welcome: open an issue to discuss changes or submit a pull request. Keep changes focused and provide a short description of the intent and testing steps.
41+
42+
License
43+
-------
44+
This sample is provided as-is for learning and demonstration purposes. Check the repository root for an explicit license file if one is included.
45+
46+
If you want, I can also add screenshots, CI build steps, or a packaged release workflow next.

0 commit comments

Comments
 (0)