miracle-wm/README.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2023-12-07 17:52:38 +03:00
# Miracle - a Tiling WM based on Mir
**Miracle** is a pleasant tiling window manager based on *Mir*. The emphasis is on usability for normal people,
rather than maximum extensibility for hackers. My goal is for everyone to enjoy the beauty of tiling window managers
without needing to be a nerd.
2023-02-18 20:06:27 +03:00
2023-10-27 23:26:34 +03:00
## Building
2023-02-25 21:09:26 +03:00
```
2023-12-07 17:52:38 +03:00
git clone https://github.com/mattkae/miracle.git
cd miracle
2023-02-18 20:06:27 +03:00
mkdir build
cd build
cmake ..
2023-12-07 17:52:38 +03:00
./bin/compositor
2023-02-18 20:06:27 +03:00
```
2023-12-07 17:52:38 +03:00
## TODOs V1
**ETA**: January 1st
- [x] Layout new window
- [x] Delete window
- [ ] Resizing windows
- [ ] Changing selected window with keyboard
- [ ] Moving window with keyboard
- [ ] Gaps in windows
- [ ] Account for minimum sizes on windows (e.g. gedit)
- [ ] Disabling many of the Floating Window Manager features
2023-02-25 21:09:26 +03:00
2023-12-07 17:52:38 +03:00
## TODOs V2
**ETA**: February 1st
- [ ] Workspaces
- [ ] Moving windows between workspaces
- [ ] Multi-output support
- [ ] Connecting new monitors
- [ ] Disconnecting monitors
- [ ] Moving windows between monitors
2023-10-27 23:26:34 +03:00
2023-12-07 17:52:38 +03:00
## TODOs V3
**ETA**: March 1st
- [ ] Configuration file
- [ ] Settings application (built in flutter ideally)
- [ ] Visual Sugar
- [ ] A workspace visualizer in the top panel (in-memory app)
- [ ] A tile visualizer in the top panel (in-memory app)