From 989f3e1b1f9dd419203a2dfc548813b49e2889b0 Mon Sep 17 00:00:00 2001 From: eythaann Date: Fri, 30 Aug 2024 12:56:28 -0500 Subject: [PATCH] docs(readme): add note on installation --- readme.md | 326 +++++++++++++++++++++++++++--------------------------- 1 file changed, 164 insertions(+), 162 deletions(-) diff --git a/readme.md b/readme.md index df8d5d9d..ae645309 100644 --- a/readme.md +++ b/readme.md @@ -1,162 +1,164 @@ -

- Seelen UI Logo - Seelen UI -

- -

- Fully Customizable Desktop Environment for Windows -
- Available in 70+ Languages -

- -
- -[![Contributors](https://img.shields.io/github/contributors/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/graphs/contributors) -[![Last Commit](https://img.shields.io/github/last-commit/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/commits/main) -[![Version](https://img.shields.io/github/v/release/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/releases) -[![Downloads](https://img.shields.io/github/downloads/eythaann/seelen-ui/total.svg)](https://github.com/eythaann/seelen-ui/releases) - -
- -Screenshot of Seelen UI desktop showing a customized desktop environment - - - - - - -
- - Download Seelen UI from Microsoft Store - - - - Join the Seelen UI Discord community - -
- -## Table of Contents -- [Overview](#overview) -- [Installation](#installation) - - [Microsoft Store (recommended)](#microsoft-store-emrecommendedem) - - [Winget](#winget) - - [.msix Installer](#msix-installer) - - [.exe Installer](#exe-installer) -- [Usage](#usage) -- [Upcoming Features](#upcoming-features) -- [Documentation](#documentation) - - [Languages](./documentation/languages.md) - - [Toolbar](./documentation/toolbar.md) - - [Themes](./documentation/themes.md) - - [Window Manager](./documentation/windows_manager.md) - - [Project](./documentation/project.md) -- [Contributing](#contributing) -- [License](#license) -- [Contact](#contact) - -## Overview -Welcome to Seelen UI, where customization meets productivity, revolutionizing your Windows desktop experience. Seamlessly integrated into your system, Seelen UI unlocks a world of possibilities, offering an extensive array of customization features to sculpt your desktop into a personalized masterpiece of efficiency and style. - -* **Unleash Your Creativity**: With Seelen UI, your desktop becomes a canvas, ready for your creative vision. From menus to widgets, every element can be tailored to reflect your unique style and workflow. - - Banner showcasing various customization options in Seelen UI - -
- -* **Boost Your Productivity**: Say goodbye to clutter and hello to organization. Seelen UI empowers you to streamline your desktop layout, ensuring that essential tools and information are always at your fingertips. Plus, with a Tiling Windows Manager for Windows, productivity reaches new heights as windows automatically arrange themselves for optimal multitasking efficiency. - - Seelen UI desktop with organized windows for efficient multitasking -
- -* **Easy and Very Customizable Configuration**: Seelen UI offers an easy and highly customizable configuration through an intuitive user interface. Tweak every aspect of your desktop experience with ease, from colors and fonts to taskbar layouts and icon arrangements, all within a few clicks. - - Example of customizable desktop settings in Seelen UI -
- -## Installation -> **⚠️ Warning**: Seelen UI requires the WebView runtime to be installed. On Windows 11, it comes pre-installed with the system. However, on Windows 10, the WebView runtime is included with the `setup.exe` installer. Additionally, Microsoft Edge is necessary to function correctly. Some users may have modified their system and removed Edge, so please ensure both Edge and the WebView runtime are installed on your system. - -You can choose from different installation options based on your preference: - -### Microsoft Store (recommended) -Download the latest version from the [Store](https://www.microsoft.com/store/productId/9P67C2D4T9FB?ocid=pdpshare) page. This is the recommended option because you will receive updates and a secure version of the program. - -***Note***: It may take around 1 to 3 business days for changes to be reflected in the Microsoft Store, as updates are approved by real people in the store. - -### Winget -Install the latest version using: - -``` pwsh -winget install --id Seelen.SeelenUI -``` -This option also uses the signed `.msix` package and ensures you have the latest secure version. Similar to the Microsoft Store, it may take around 1 to 3 business days for changes to be reflected in Winget, as updates are approved by real people in the `winget-pkg` project. - -### .msix Installer -Download the `.msix` installer from the [Releases](https://github.com/eythaann/seelen-ui/releases) page. This package is signed, ensuring a secure installation. This is the same option as the Microsoft Store but is a portable installer. - -### .exe Installer -Download the latest version from the [Releases](https://github.com/eythaann/seelen-ui/releases) page and run the `setup.exe` installer. This option is less recommended as the installer is not signed, which may cause it to be flagged as a potential threat by some antivirus programs. The `setup.exe` is updated more quickly than the Microsoft Store or Winget versions and also it receives notifications updates on new release. - -## Usage - -Once installed or extracted, simply open the program. The easy-to-use and intuitive GUI will guide you through the configuration process. Customize your desktop environment effortlessly. - -## Documentation - -For in-depth details on various aspects of Seelen UI, explore the following documents: -- [Languages](./documentation/languages.md) - Information regarding translations. -- [Toolbar](./documentation/toolbar.md) - Details about customizing and using the toolbar. -- [Themes](./documentation/themes.md) - Guidance on creating and applying themes. -- [Window Manager](./documentation/windows_manager.md) - Instructions on configuring the window manager. -- [Project](./documentation/project.md) - General information about the project and its structure. - -## Upcoming Features - -I’m excited to share some upcoming features for Seelen UI! Here’s a glimpse of what’s planned for the future: - -### App Launcher -I’m planning to develop an app launcher inspired by [Rofi](https://github.com/davatorium/rofi) on Linux. This feature will provide a sleek and highly customizable way to quickly access your applications. - -![App Launcher Preview](https://raw.githubusercontent.com/adi1090x/files/master/rofi/previews/colorful/main.gif) -*Image courtesy of [rofi-themes](https://github.com/dctxmei/rofi-themes)* - - -### Customizable Popup Widgets -I aim to introduce a set of fully customizable popup widgets, similar to the features available in [EWW](https://github.com/elkowar/eww). These widgets will be highly configurable and adaptable to your needs, providing an enhanced and interactive way to manage your desktop environment. - -![Customizable Widgets Preview](https://raw.githubusercontent.com/adi1090x/widgets/main/previews/dashboard.png) -*Image courtesy of [adi1090x](https://github.com/adi1090x/widgets)* - -### Custom Alt + Tab (Task Switching) -An upgraded Alt + Tab system for task switching is on the horizon. This will offer a more visually appealing and functional experience, allowing for smoother transitions between open applications and windows. - -### Custom Virtual Desktops Viewer and Animations -I’m also working on a custom virtual desktops viewer and dynamic animations to improve navigation between different workspaces. This will provide a more intuitive and immersive multitasking experience. - -Stay tuned for more updates as I develop these features. I appreciate your support and enthusiasm! - -Happy customizing! - -The Seelen UI Team - -## Contributing - -We welcome contributions! -* Read the [Contribution Guidelines](CONTRIBUTING) to get started with terms. -* Read the [Project Documentation](documentation/project.md) to understand the project structure and how to use it. - -## License - -See the [LICENSE](LICENSE) file for details. - -## Contact - -For inquiries and support, please contact me on [Discord](https://discord.gg/ABfASx5ZAJ). +

+ Seelen UI Logo + Seelen UI +

+ +

+ Fully Customizable Desktop Environment for Windows +
+ Available in 70+ Languages +

+ +
+ +[![Contributors](https://img.shields.io/github/contributors/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/graphs/contributors) +[![Last Commit](https://img.shields.io/github/last-commit/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/commits/main) +[![Version](https://img.shields.io/github/v/release/eythaann/seelen-ui.svg)](https://github.com/eythaann/seelen-ui/releases) +[![Downloads](https://img.shields.io/github/downloads/eythaann/seelen-ui/total.svg)](https://github.com/eythaann/seelen-ui/releases) + +
+ +Screenshot of Seelen UI desktop showing a customized desktop environment + + + + + + +
+ + Download Seelen UI from Microsoft Store + + + + Join the Seelen UI Discord community + +
+ +## Table of Contents +- [Overview](#overview) +- [Installation](#installation) + - [Microsoft Store (recommended)](#microsoft-store-emrecommendedem) + - [Winget](#winget) + - [.msix Installer](#msix-installer) + - [.exe Installer](#exe-installer) +- [Usage](#usage) +- [Upcoming Features](#upcoming-features) +- [Documentation](#documentation) + - [Languages](./documentation/languages.md) + - [Toolbar](./documentation/toolbar.md) + - [Themes](./documentation/themes.md) + - [Window Manager](./documentation/windows_manager.md) + - [Project](./documentation/project.md) +- [Contributing](#contributing) +- [License](#license) +- [Contact](#contact) + +## Overview +Welcome to Seelen UI, where customization meets productivity, revolutionizing your Windows desktop experience. Seamlessly integrated into your system, Seelen UI unlocks a world of possibilities, offering an extensive array of customization features to sculpt your desktop into a personalized masterpiece of efficiency and style. + +* **Unleash Your Creativity**: With Seelen UI, your desktop becomes a canvas, ready for your creative vision. From menus to widgets, every element can be tailored to reflect your unique style and workflow. + + Banner showcasing various customization options in Seelen UI + +
+ +* **Boost Your Productivity**: Say goodbye to clutter and hello to organization. Seelen UI empowers you to streamline your desktop layout, ensuring that essential tools and information are always at your fingertips. Plus, with a Tiling Windows Manager for Windows, productivity reaches new heights as windows automatically arrange themselves for optimal multitasking efficiency. + + Seelen UI desktop with organized windows for efficient multitasking +
+ +* **Easy and Very Customizable Configuration**: Seelen UI offers an easy and highly customizable configuration through an intuitive user interface. Tweak every aspect of your desktop experience with ease, from colors and fonts to taskbar layouts and icon arrangements, all within a few clicks. + + Example of customizable desktop settings in Seelen UI +
+ +## Installation +> **⚠️ Warning**: Seelen UI requires the WebView runtime to be installed. On Windows 11, it comes pre-installed with the system. However, on Windows 10, the WebView runtime is included with the `setup.exe` installer. Additionally, Microsoft Edge is necessary to function correctly. Some users may have modified their system and removed Edge, so please ensure both Edge and the WebView runtime are installed on your system. + +> **🗒️ Note**: On fresh installations of Windows, the app might show a white or dark screen. You only need to update your Windows through Windows Update and restart your PC. + +You can choose from different installation options based on your preference: + +### Microsoft Store (recommended) +Download the latest version from the [Store](https://www.microsoft.com/store/productId/9P67C2D4T9FB?ocid=pdpshare) page. This is the recommended option because you will receive updates and a secure version of the program. + +***Note***: It may take around 1 to 3 business days for changes to be reflected in the Microsoft Store, as updates are approved by real people in the store. + +### Winget +Install the latest version using: + +``` pwsh +winget install --id Seelen.SeelenUI +``` +This option also uses the signed `.msix` package and ensures you have the latest secure version. Similar to the Microsoft Store, it may take around 1 to 3 business days for changes to be reflected in Winget, as updates are approved by real people in the `winget-pkg` project. + +### .msix Installer +Download the `.msix` installer from the [Releases](https://github.com/eythaann/seelen-ui/releases) page. This package is signed, ensuring a secure installation. This is the same option as the Microsoft Store but is a portable installer. + +### .exe Installer +Download the latest version from the [Releases](https://github.com/eythaann/seelen-ui/releases) page and run the `setup.exe` installer. This option is less recommended as the installer is not signed, which may cause it to be flagged as a potential threat by some antivirus programs. The `setup.exe` is updated more quickly than the Microsoft Store or Winget versions and also it receives notifications updates on new release. + +## Usage + +Once installed or extracted, simply open the program. The easy-to-use and intuitive GUI will guide you through the configuration process. Customize your desktop environment effortlessly. + +## Documentation + +For in-depth details on various aspects of Seelen UI, explore the following documents: +- [Languages](./documentation/languages.md) - Information regarding translations. +- [Toolbar](./documentation/toolbar.md) - Details about customizing and using the toolbar. +- [Themes](./documentation/themes.md) - Guidance on creating and applying themes. +- [Window Manager](./documentation/windows_manager.md) - Instructions on configuring the window manager. +- [Project](./documentation/project.md) - General information about the project and its structure. + +## Upcoming Features + +I’m excited to share some upcoming features for Seelen UI! Here’s a glimpse of what’s planned for the future: + +### App Launcher +I’m planning to develop an app launcher inspired by [Rofi](https://github.com/davatorium/rofi) on Linux. This feature will provide a sleek and highly customizable way to quickly access your applications. + +![App Launcher Preview](https://raw.githubusercontent.com/adi1090x/files/master/rofi/previews/colorful/main.gif) +*Image courtesy of [rofi-themes](https://github.com/dctxmei/rofi-themes)* + + +### Customizable Popup Widgets +I aim to introduce a set of fully customizable popup widgets, similar to the features available in [EWW](https://github.com/elkowar/eww). These widgets will be highly configurable and adaptable to your needs, providing an enhanced and interactive way to manage your desktop environment. + +![Customizable Widgets Preview](https://raw.githubusercontent.com/adi1090x/widgets/main/previews/dashboard.png) +*Image courtesy of [adi1090x](https://github.com/adi1090x/widgets)* + +### Custom Alt + Tab (Task Switching) +An upgraded Alt + Tab system for task switching is on the horizon. This will offer a more visually appealing and functional experience, allowing for smoother transitions between open applications and windows. + +### Custom Virtual Desktops Viewer and Animations +I’m also working on a custom virtual desktops viewer and dynamic animations to improve navigation between different workspaces. This will provide a more intuitive and immersive multitasking experience. + +Stay tuned for more updates as I develop these features. I appreciate your support and enthusiasm! + +Happy customizing! + +The Seelen UI Team + +## Contributing + +We welcome contributions! +* Read the [Contribution Guidelines](CONTRIBUTING) to get started with terms. +* Read the [Project Documentation](documentation/project.md) to understand the project structure and how to use it. + +## License + +See the [LICENSE](LICENSE) file for details. + +## Contact + +For inquiries and support, please contact me on [Discord](https://discord.gg/ABfASx5ZAJ).