diff --git a/README.md b/README.md index 5e6b11a..227fee4 100644 --- a/README.md +++ b/README.md @@ -1 +1,167 @@ -# WinUIApp \ No newline at end of file +# WinUIApp + +A modern Windows desktop application built with WinUI 3 and .NET 8, featuring a sleek user interface with Mica backdrop effects and comprehensive user management capabilities. + +## πŸ“‹ Overview + +WinUIApp is a feature-rich Windows application that provides a multi-page navigation experience with user authentication, dashboard analytics, system tools, and personalized settings. The application leverages the latest Windows App SDK to deliver a native Windows 11 experience. + +## ✨ Features + +- **User Authentication**: Secure login system with user credential management +- **Modern UI Design**: + - Mica backdrop effect for a translucent, modern appearance + - Custom title bar with minimize, maximize, and close controls + - Responsive design that adapts to window size changes +- **Multi-Page Navigation**: + - **Dashboard**: Main application hub with overview and analytics + - **History**: Track and review application history + - **Profile**: User profile management and personalization + - **Settings**: Application configuration and preferences + - **System Tools**: Utilities and system management features +- **Cross-Platform Support**: Built for x86, x64, and ARM64 architectures + +## πŸ› οΈ Technology Stack + +- **Framework**: .NET 8.0 +- **UI Framework**: WinUI 3 (Windows App SDK 1.6) +- **Target Platform**: Windows 10 (19041) and above +- **Minimum Version**: Windows 10 (17763) +- **Language**: C# with XAML +- **Deployment**: Unpackaged application (self-contained) + +## πŸ“¦ Prerequisites + +Before building and running WinUIApp, ensure you have the following installed: + +- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) or later +- [Visual Studio 2022](https://visualstudio.microsoft.com/) (17.8 or later) with: + - .NET Desktop Development workload + - Windows App SDK (automatically included) +- Windows 10 SDK (10.0.22621.0 or later) +- Windows 10 version 17763 or later + +## πŸš€ Getting Started + +### Clone the Repository + +```bash +git clone https://github.com/Stacktor/WinUIApp.git +cd WinUIApp +``` + +### Build the Project + +Using Visual Studio: +1. Open `WinUIApp.sln` in Visual Studio 2022 +2. Select your target platform (x86, x64, or ARM64) +3. Build the solution (Ctrl+Shift+B) + +Using .NET CLI: +```bash +dotnet restore +dotnet build +``` + +### Run the Application + +Using Visual Studio: +- Press F5 or click the "Start" button + +Using .NET CLI: +```bash +dotnet run --project WinUIApp/WinUIApp.csproj +``` + +## πŸ“ Project Structure + +``` +WinUIApp/ +β”œβ”€β”€ WinUIApp/ +β”‚ β”œβ”€β”€ Assets/ # Application assets (icons, images) +β”‚ β”œβ”€β”€ Properties/ # Assembly information +β”‚ β”œβ”€β”€ Windows/ # Windows-specific configurations +β”‚ β”œβ”€β”€ App.xaml # Application definition +β”‚ β”œβ”€β”€ App.xaml.cs # Application startup logic +β”‚ β”œβ”€β”€ MainWindow.xaml # Main window UI +β”‚ β”œβ”€β”€ MainWindow.xaml.cs # Main window logic with Mica backdrop +β”‚ β”œβ”€β”€ LoginPage.xaml # User authentication page +β”‚ β”œβ”€β”€ MainHub.xaml # Central navigation hub +β”‚ β”œβ”€β”€ DashboardPage.xaml # Dashboard view +β”‚ β”œβ”€β”€ HistoryPage.xaml # History tracking +β”‚ β”œβ”€β”€ ProfilePage.xaml # User profile +β”‚ β”œβ”€β”€ SettingsPage.xaml # Application settings +β”‚ └── SystemToolsPage.xaml # System utilities +β”œβ”€β”€ WinUIApp.sln # Visual Studio solution file +└── README.md # This file +``` + +## πŸ”§ Configuration + +### Supported Platforms + +The application supports the following platforms: +- x86 (32-bit) +- x64 (64-bit) +- ARM64 + +### Build Configuration + +The project is configured as an unpackaged application with self-contained Windows App SDK deployment. This means: +- No MSIX packaging required +- Easier deployment and distribution +- All dependencies bundled with the application + +## 🎨 UI Features + +### Mica Backdrop +The application features a modern Mica backdrop effect that: +- Provides a translucent, layered appearance +- Adapts to system light/dark theme +- Falls back gracefully on unsupported systems + +### Custom Title Bar +A fully customized title bar with: +- Minimize, maximize/restore, and close buttons +- Extended content area for immersive experience +- Dynamic icon changes based on window state + +## 🀝 Contributing + +Contributions are welcome! Please feel free to submit issues or pull requests. + +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/AmazingFeature`) +3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## πŸ“„ License + +This project is available for use under standard open-source practices. Please check the repository for specific license information. + +## πŸ“ž Support + +For questions, issues, or suggestions: +- Open an issue on [GitHub Issues](https://github.com/Stacktor/WinUIApp/issues) +- Contact the maintainers through GitHub + +## πŸ”„ Recent Updates + +- βœ… Implemented user authentication system +- βœ… Enhanced UI with modern navigation patterns +- βœ… Improved application window management +- βœ… Added comprehensive page navigation (Dashboard, History, Profile, Settings, System Tools) + +## πŸ—ΊοΈ Roadmap + +Future enhancements may include: +- Database integration for persistent user data +- Cloud synchronization capabilities +- Additional system tools and utilities +- Enhanced analytics and reporting +- Plugin system for extensibility + +--- + +**Built with ❀️ using WinUI 3 and .NET 8**