README.md

Rabbit HUD

Creates Overlay Windows meant to be used in conjunction with IINACT
Explore the docs »

Report Bug or request Feature

Table of Contents

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

About The Project

Rabbit HUD is a linux spiritual clone of Bunny HUD from marzent. It is meant to provide a similar experience on Linux.

The current selection of overlay managers for Linux are mediocre at best.

(back to top)

Built With

(back to top)

Getting Started

To get started with Rabbit HUD, there are the following three ways. Each come with their pros and cons.

TO DO

(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 EUPL License. See LICENSE for more information.

(back to top)

Contact

Kura Bloodlust

• Fediverse: @[email protected]
• Semi Official Discord: IINACT #help-linux

Project Link: https://github.com/cking/rabbithud

(back to top)

Acknowledgments

• marzent for Bunny HUD and IINACT

(back to top)