adbrucker/xmonad-recording-layout
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation.

Browse Source
This commit is contained in:
Achim D. Brucker 2025-07-10 20:55:41 +01:00
parent 5d703ac967
commit 5d9e620a4c
1 changed files with 51 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,3 +1,52 @@
# xmonad-recording-layout
# An XMonad Layout for Recording and Screen-Sharing on Ultra-Wide Displays
A layout for XMonad optimized for recording and screen-sharing on ultra-wide screens.
A layout for the [XMonad](https://xmonad.org/) window manager for X11 that is optimized for recording and screen-sharing on ultra-wide displays. At its core, it is a variant of the `ThreColMid` layout, i.e., a three column layout with the main window in the middle column. The specific feature of the `Recording` layout is that the size of the main window is guaranteed to be a standard resolution (either 16x9, 16x10, or 4x3).
## Installation
Copy the provided `Recording.hs` into your `$HOME/.xmonad` directory. In your `xmonad.hs` file, import the new layout:
```Haskell
import LH.Recording
```
and add the new Layout to your list of layouts, e.g.,
```Haskell
myLayoutHook = avoidStruts (smartBorders( (layoutHook def)
||| ThreeColMid 1 (3/100) (1/2)
||| tabbed shrinkText myTabConfig
||| Recording 2 R16x9 4))
```
The `Recording` layout accepts three parameters:
* the first parameter is the number of windows in the middle column,
* the second parameter is the aspect ration, i.e.,
* `R4x3` for fixing the middle column to 4x3 resolutions. The list of supported resolutions is: `[(640, 480), (800, 600), (960, 720), (1024, 768), (1280, 960), (1400, 1050), (1440, 1080 ), (1600, 1200), (1856, 1392), (1920, 1440), (2048, 1536)]`,
* `R16x10` for fixing the middle column to 16x10 resolutions. The list of supported resolutions is: `[(1280, 800), (1440, 900), (1680, 1050), (1920, 1200), (2560, 1600)]`,
* * `R16x9` for fixing the middle column to 16x9 resolutions. The list of supported resolutions is: `[(640, 360), (768, 432), (896, 504), (1024, 576), (1152, 648), (1280, 720), (1366, 768), (1600, 900), (1920, 1080), (2560, 1440), (3840, 2160)]`,
* the default resolution, specified as position in the list of supported resolutions for the chosen aspect ratio.
## Authors
### Main Contacts
* [Achim D. Brucker](http://brucker.ch/)
### Contributors
## License
This project is licensed under a two-clause BSD license. Note that individual
plug-ins might have different license and usage restrictions. If a plugin has a
different license, a LICENSE file is provided in the corresponding plug-in
directory.
SPDX-License-Identifier: BSD-3-Clause
## Upstream Repository
The upstream git repository, i.e., the single source of truth, for this project
is hosted by the [Software Assurance & Security Research Team](https://logicalhacking.com)
at <https://git.logicalhacking.com/adbrucker/xmonad-recording-layout/>.