Home

Awesome

synth-shell-greeter

This script is part of synth-shell

synth-shell-greeter shows a summary of your system's current health.

<br/><br/>

<!--------------------------------------+-------------------------------------->

Setup

<!--------------------------------------+-------------------------------------->

Arch Linux

You may install synth-shell-greeter from AUR: https://aur.archlinux.org/packages/synth-shell-greeter-git/

Manual setup

The included setup script will guide you step by step through the installation process. Just clone this repository and run it:

git clone --recursive https://github.com/andresgongora/synth-shell-greeter.git
synth-shell-greeter/setup.sh

You can then test your script by running it from wherever you installed it. Usually this is to your user's .config folder, so you should run:

~/.config/synth-shell/synth-shell-greeter.sh

If you want it to appear everytime you open a new terminal, run

echo "~/.config/synth-shell/synth-shell-greeter.sh" >> ~/.bashrc

Configuration/customization

You can configure your scripts by modifying the corresponding configuration files. You can find them, along example configuration files, in the following folders depending on how you installed synth-shell:

<br/><br/>

<!--------------------------------------+-------------------------------------->

Overview

<!--------------------------------------+-------------------------------------->

synth-shell-greeter provides a summarized system report at a single glance every time you open up a new terminal. If it detects that any system parameter (e.g. CPU load, memory, etc.) is over a critical threshold, it will provide a warning and additional information about the cause. Last but not least, it prints a user-configurable ASCII logo to impress your crush from the library with how awesome you are.

Feel free to customize your status report through the many available options in ~/.config/synth-shell/synth-shell-greeter.config (user-only install) or /etc/synth-shell/synth-shell-greeter.config (system-wide install), or by replacing their content with the examples files you can find under the same directory.

greeter configuration options

<br/><br/>

<!--------------------------------------+-------------------------------------->

Contribute

<!--------------------------------------+-------------------------------------->

This project is only possible thanks to the effort and passion of many, including developers, testers, and of course, our beloved coffee machine. You can find a detailed list of everyone involved in the development in AUTHORS.md. Thanks to all of you!

If you like this project and want to contribute, you are most welcome to do so.

Help us improve

<br/><br/>

<!--------------------------------------+-------------------------------------->

About

<!--------------------------------------+-------------------------------------->

synth-shell-greeter is part of synth-shell

<br/><br/>

<!--------------------------------------+-------------------------------------->

License

<!--------------------------------------+-------------------------------------->

Copyright (c) 2014-2021, Andres Gongora - www.andresgongora.com