Create README.md
This commit is contained in:
parent
8ea0ea7d1f
commit
b70846f26f
36
README.md
Normal file
36
README.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# WallpaperEngine-Linux (ColorWall for Linux By Laxenta)
|
||||
|
||||
### An open-source, ultra-lightweight live wallpaper and desktop customization engine for Linux systems, built using Rust and Tauri.
|
||||
> we have a proprietary project for windows, https://colorwall.xyz (in future it will be plan to change it to moe or something funny haha)
|
||||
## Project Status: Target Mid-June 2026
|
||||
This repository is currently a placeholder skeleton. Active code development and repository initialization are scheduled to begin in mid-June 2026, aligning with the official Microsoft Store release of the Windows client.
|
||||
Take it all with a grain of salt, i know what to do but full research will help the score and plan more! i am busy a little for now, so yea! i will do it soon!
|
||||
## Planned Features
|
||||
* **Low-Overhead Performance:** Built on Rust and Tauri to maintain under 1% CPU utilization during video rendering.
|
||||
* **Linux Compositor Integration:** High-performance background scene composition with zero-latency input handling.
|
||||
* **Studio Scene Editor:** Node-based editor to combine interactive WebGL, shaders, and layered video assets.
|
||||
* **Desktop Widgets:** Pin responsive, sandboxed HTML5/React tools directly to the desktop workspace.
|
||||
* **Taskbar Customization:** Independent native control over panel transparency and acrylic blur effects.
|
||||
|
||||
## System Requirements & Prerequisites
|
||||
* **We will try to have these as the Supported OS:** Major Linux distributions (Ubuntu, Debian, Fedora, Arch Linux).
|
||||
|
||||
## Local Development & Compilation
|
||||
When the initial codebase is pushed, developers can clone and compile the project locally using standard Tauri tooling:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com
|
||||
|
||||
# Navigate to the directory
|
||||
cd WallpaperEngine-Linux
|
||||
|
||||
# Run the development environment
|
||||
cargo tauri dev
|
||||
```
|
||||
|
||||
## Contributing
|
||||
Contributions will be highly welcome once the source files are initialized. Please review `CONTRIBUTING.md` before submitting bug reports, feature requests, or pull requests.
|
||||
|
||||
## License
|
||||
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
|
||||
Loading…
Reference in a new issue