mirror of
https://github.com/miracle-wm-org/miracle-wm.git
synced 2024-11-23 21:13:53 +03:00
readme: needs refining, but its ok
This commit is contained in:
parent
ea9376b4d7
commit
bcbfd48186
60
README.md
60
README.md
@ -1,9 +1,14 @@
|
|||||||
# Miracle - a Tiling WM based on Mir
|
# miracle
|
||||||
**Miracle** is a pleasant tiling window manager based on *Mir*. The emphasis is on usability for normal people,
|
**miracle** is a _Mir_-based wayland desktop environment inspired by modern IDEs like CLion. The window manager intends
|
||||||
rather than maximum extensibility for hackers. My goal is for everyone to enjoy the beauty of tiling window managers
|
to provide a typical tiling window management experience (akin to i3 or sway). The shell itself focuses on extendability
|
||||||
without needing to be a nerd.
|
for power users while at the same time having an accessible user interface. While window managers like i3 and sway
|
||||||
|
are simple and easy-to-use, I find that there's a niche missing for programmers who want an out-of-the-box solution
|
||||||
|
to an ergonomic but heavy-hitter desktop environment.
|
||||||
|
|
||||||
## Building
|
**WARNING**: This project is very much a work in progress. I have provided a rough roadmap in the timeline section.
|
||||||
|
Use at your own risk.
|
||||||
|
|
||||||
|
# Building
|
||||||
```
|
```
|
||||||
git clone https://github.com/mattkae/miracle.git
|
git clone https://github.com/mattkae/miracle.git
|
||||||
cd miracle
|
cd miracle
|
||||||
@ -14,30 +19,47 @@ cmake ..
|
|||||||
./bin/compositor
|
./bin/compositor
|
||||||
```
|
```
|
||||||
|
|
||||||
## TODOs V1
|
# Timeline
|
||||||
**ETA**: January 1st
|
## Tiling Window Manager (Due: January 1st)
|
||||||
|
Version: 0.1
|
||||||
|
|
||||||
|
Features:
|
||||||
- [x] Layout new window
|
- [x] Layout new window
|
||||||
- [x] Delete window
|
- [x] Delete window
|
||||||
- [ ] Resizing windows
|
- [x] Resizing windows
|
||||||
- [ ] Changing selected window with keyboard
|
- [x] Changing selected window with keyboard
|
||||||
- [ ] Moving window with keyboard
|
- [x] Moving window with keyboard
|
||||||
- [ ] Gaps in windows
|
- [ ] Gaps in windows
|
||||||
- [ ] Account for minimum sizes on windows (e.g. gedit)
|
- [ ] Account for minimum sizes on windows (e.g. gedit)
|
||||||
- [ ] Disabling many of the Floating Window Manager features
|
- [ ] Disabling many of the Floating Window Manager features
|
||||||
|
- [ ] Handle exclusion zones
|
||||||
|
- [ ] Handle output creation, updating, and deletion
|
||||||
|
- [ ]
|
||||||
|
|
||||||
## TODOs V2
|
## Tiling Advanced + Initial Shell (Due: February 1st)
|
||||||
**ETA**: February 1st
|
Version: 0.2
|
||||||
|
|
||||||
|
Features:
|
||||||
- [ ] Workspaces
|
- [ ] Workspaces
|
||||||
- [ ] Moving windows between workspaces
|
- [ ] Moving windows between workspaces
|
||||||
- [ ] Multi-output support
|
- [ ] Launcher (Rust + GTK most likely)
|
||||||
- [ ] Connecting new monitors
|
- [ ] Favorite applications
|
||||||
- [ ] Disconnecting monitors
|
- [ ] Opened applications
|
||||||
- [ ] Moving windows between monitors
|
- [ ] Favorite folders
|
||||||
|
- [ ] Pinned scripts
|
||||||
|
- [ ] Top Panel
|
||||||
|
- [ ] Clock
|
||||||
|
- [ ] Battery indicator
|
||||||
|
- [ ] Wifi Indicator
|
||||||
|
- [ ] Lock Screen
|
||||||
|
|
||||||
## TODOs V3
|
## Tiling More Advanced +
|
||||||
**ETA**: March 1st
|
Version: 0.3
|
||||||
|
|
||||||
|
Features:
|
||||||
|
- [ ] UI Cleanup
|
||||||
- [ ] Configuration file
|
- [ ] Configuration file
|
||||||
- [ ] Settings application (built in flutter ideally)
|
- [ ] Settings application
|
||||||
- [ ] Visual Sugar
|
- [ ] Visual Sugar
|
||||||
- [ ] A workspace visualizer in the top panel (in-memory app)
|
- [ ] A workspace visualizer in the top panel (in-memory app)
|
||||||
- [ ] A tile visualizer in the top panel (in-memory app)
|
- [ ] A tile visualizer in the top panel (in-memory app)
|
Loading…
Reference in New Issue
Block a user