README.txt

                                ━━━━━━━━
                                 PLYPPY
                                ━━━━━━━━


A Plymouth Boot Splash Generator <./plyppy.gif>


1 Actual Example
════════════════

  • Source GIF
  <./source.gif>
  • Generated Boot Splash
  <./output.gif>


2 Features
══════════

  • ✨ Beautiful CLI interface made with [rich]
  • ✂️ Removes backgrounds with [rembg] for cleaner splash screens
  • 📷 Supports images, GIFs and videos
  • 🎨 Supports color customization
  • 💾 Automatically installs the boot splash
  • 🔒 Comes with a password prompt


[rich] <https://github.com/Textualize/rich>

[rembg] <https://github.com/danielgatis/rembg>


3 Installation
══════════════

3.1 From Source
───────────────

  First, clone the repository and `cd' into the directory
  ┌────
  │ git clone https://github.com/cel7t/plyppy.git
  │ cd plyppy
  └────
  Next, install the package with `pip'
  ┌────
  │ pip install .
  └────


3.2 From pip
────────────

  You can also install the package from `pip' by running
  ┌────
  │ pip install plyppy
  └────


4 Usage
═══════

  Before using the program, ensure that you have Plymouth installed and
  set up properly.  To use the program, simply run `plyppy'.


5 License
═════════

  This program is licensed under the GPLv3 license. Refer to the
  [LICENSE] file for more details.  © 2024 Sarthak Shah
  (shahsarthakw@gmail.com)


[LICENSE] <file:LICENSE>