🗨️ Quoterm

A CLI tool for greeting you and your terminal with beautiful quotes around the day.

📖 Table of Contents

• ✨ Features
• 🚀 Installation
• 🛠️ Usage
• 🗑️ Uninstall
• 🐛 Bugs or Requests
• 🤝 Contributing
• 📄 License
• 🙏 Acknowledgments

✨ Features

• Quotes: Greets you with random quotes every time you open your terminal.
• Reactive: Formatting changes based on the width of your terminal.
• Stay Motivated: Get motivational & thought-provoking quotes.

🚀 Installation

Please note that you should have Rust installed on your system.

• Clone this repo using

git clone http://github.com/jollySleeper/quoterm.git ~/quoterm && cd ~/quoterm

• Run these commands to install

cargo build --release
cargo install --path .

🛠️ Usage

Please add ~/.cargo/bin/ to your PATH.

• Append the following snippet to your shell rc file:

if type "quoterm" > /dev/null; then
    quoterm 
fi

🗑️ Uninstall

If you decide to uninstall, we're sorry to hear that quoterm didn't meet your expectations. We appreciate your feedback. To uninstall, run rm ~/.cargo/bin/quoterm from terminal and delete the Quoterm folder using rm -r quoterm command.

🐛 Bugs or Requests

If you encounter any problem(s) feel free to open an issue. If you feel the project is missing a feature, please raise an issue with FeatureRequest as heading.

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• This project takes inspiration from Please and many other similar projects.
• The quotes displayed by this CLI tool is provided by the JSON File in Please.