awesome-archive / panda-motd

A utility for generating a more useful MOTD.

panda-motd is a utility for generating a more useful MOTD.

Disclaimer

panda-motd is under heavy development and while the release versions 'should' work, there's a real chance that things break. Understand that you might have issues. If you run into any, please open an issue, provided nobody has already created one for your particular problem.

Getting started

Prerequisites

• Ruby >= 2.3
• Some flavor of Linux

Installing

To install the latest 'stable' release of panda-motd:

sudo gem install panda-motd

At this point, you can run panda-motd ~/.config/panda-motd.yaml (without sudo) from anywhere, which will generate a configuration file located at ~/.config/panda-motd.yaml. This file contains a description of each component of the MOTD and how to enable/disable/configure each one. Components are printed in your MOTD in the same order that they are defined in this configuration file.

Actually getting the output of the gem to become your MOTD is going to depend on your Linux distribution. Please find your Linux distribution on this wiki page and follow the instructions.

Contributing

Due to the fact that this project is very new, things are changing very rapidly. Things are now in a state where I am semi-comfortable with people submitting pull requests. Please open an issue regarding any changes you wish to make before starting to work on anything. Additionally, I don't have much experience in the open-source world, so please forgive me as I familiarize myself with the contribution process. This is very much a learning process for me at the moment.

I am always open to providing assistance, so if you need to ask any questions please don't hesitate to do so, whether it be how to approach solving a problem or questions regarding how I might prefer something be implemented.

Running tests

I use rspec for testing. If submitting a pull request, always include tests if possible. Please adhere to the testing style in the pre-existing tests, particularly when testing a new component.

Made Possible By

I'd like to use this section to thank the developers and contributors of the gems that make this gem possible.

• artii: Generate cool ASCII text art
• colorize: Easily color terminal text
• ruby-units: A comprehensive unit conversion library
• sysinfo: An easy, cross-platform way to get system information

Many of the design cues and the original idea of a highly configurable MOTD are from /u/LookAtMyKeyboard on Reddit, from this thread in particular.