Welcome to gstuff!

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Gstuff is a very lightweight and deamon-less notification program built with X11 libraries that can show a box with customizable text in it.

Built With

• X11

Prerequisites

In order to use gstuff you should be running the X11 window system. To compile gstuff from source you should have cmake and make installed.

Installation

1. Clone the repo

   git clone https://github.com/gabriele-0201/gstuff.git

2. Open it in a terminal
3. Create a buld/ directory

   mkdir ./build 

4. Run cmake to generate Makefile and config files

   cmake -S . -B ./build

5. Compile with make

   make -C ./build

Now your executable program sohould be at ./build/gstuff and you can run a test by executing

./build/gstuff "hello world"

(back to top)

Usage

You can run the program with the default config just by using

gstuff "your text here" "this text goes to the 2nd line" "this text goes to the 3rd line"

Or you can specify a configuration following this steps:

• Copy config_template.conf into $HOME/.config/gstuff and rename it as you wish, we will call it <myConfig>.conf

  mkdir $HOME/.config/gstuff
  cp ./config_template.conf $HOME/.config/gstuff
  mv $HOME/.config/gstuff/config_template.conf $HOME/.config/gstuff/<myConfig>.conf

• Edit the configration accordingly to your needs
  • Note: the fonts can be listed with xlsfonts
• Run gstuff specifying the configuration name (not file):

  gstuff --<myConfig> "your text here" "this text goes to the 2nd line" "this text goes to the 3rd line"

• See the config file format guide to customize your gstuff banner and have fun!

Here are some example usecases:

• Getting status of your system with a keybinding
• Having a customizable slider for display backlight and/or volume
• Integrating notification capabilities in your own project
• Showing reminders or timers

TODO/Roadmap

• Add images in README
• Add some examples
• Add full UTF8 support
• Implement monitor selection

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

Contributing

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.