TDAWm

This project is a X11 Window Manager written in Rust. It's not meant to be the fastest, the lightest, the more extensible or whatever. I just wanted something simple that just works; I used to work with dwm but I wanted something I could better fit to my needs.
This project has simplicity in mind. I want the code to be clear and the end product a breath to use.

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

This project is made in Rust.

(back to top)

Getting Started

Prerequisites

The only prerequisite is X11. You probably already have it otherwise you wouldn't be here i guess.

Installation

There is no package distribution so at the moment you will have to clone this repository

git clone https://github.com/tdaron/tdawm

and then build it using cargo

cargo build --release

The executable will be placed in target/release/tdawm.

Simply put it inside your .xinitrc and there you go !

(back to top)

Usage

There is still not any documentation as this project is still a POC atm.

(back to top)

Roadmap

• Basic X11 window manager (handle events)
• Basic layouts (horizontal + vertical)
• Basic workspaces
• Multiple screens support (using Xinemara)
• Basic (EWMH)[https://en.wikipedia.org/wiki/Extended_Window_Manager_Hints] protocol support
• 2D Workspaces (experiment)
• Linked workspaces between screens (mirroring some workspaces between 2 screens)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Théo Daron - [email protected]

Project Link: https://github.com/tdaron/tdawm

(back to top)

Acknowledgments

(back to top)