Skip to content

simon0302010/gridwm

Repository files navigation

GridWM

GridWM is a tiling X11 based window manager for Linux. This project is still in its early stages of development and lacks many features.

⚠️ This project does not support Windows or macOS.

Demo

GridWM0001-2718.mp4

Features

  • Basic tiling window management
  • Moveable windows
  • Resizable windows
  • Customizable keyboard shortcuts for managing windows and workspaces
  • Customizable keyboard shortcuts for running custom commands
  • Easy to configure using a config file
  • Multi-desktop support
  • Lightweight
  • Configurable top bar that can show many different widgets
  • Written in Rust

Todo

  • Display popups properly
  • Configurable text size
  • Add support for notifications
  • Add support for multi-monitor setups

Installation

  1. Install Dependencies

    Debian based systems:

    sudo apt install xserver-xorg xinit x11-xserver-utils x11-xkb-utils xorg pkg-config libx11-dev libxinerama-dev libxrandr-dev

    Arch based systems:

    sudo pacman -S xorg-server xorg-xinit xorg-setxkbmap xorg-xsetroot libxrandr
  2. Install Binary

    You can download the latest release binary from the releases page and place it in a directory included in your system's PATH, such as /usr/local/bin.

    Alternatively, you can build from source:

    cargo install --git https://github.com/simon0302010/gridwm.git

    Make sure you have Rust and Cargo installed on your system and added ~/.cargo/bin added to your PATH before running the above command.

  3. Create Configuration File You can look at the CONFIGURATION.md file for details on how to create a configuration file for GridWM. The configuration file should be located at ~/.config/gridwm/gridwm.toml.

    If the configuration file or any options are missing, GridWM will use default settings.

Usage

To start GridWM, run:

startx path/to/gridwm

Contributing

If you are interested in a specific feature or want to report a bug, feel free to create a GitHub issue. Pull requests are also welcome.

License

This project is licensed under the GNU General Public License Version 3. See the LICENSE file for details.

About

A tiling X11 based window manager for Linux.

Resources

License

Stars

Watchers

Forks

Languages