Skip to content

Latest commit

 

History

History
223 lines (172 loc) · 5.46 KB

README.md

File metadata and controls

223 lines (172 loc) · 5.46 KB
Raw
|==========================================|
 ██╗     ██╗███╗   ███╗ ██████╗      ██╗██╗
 ██║     ██║████╗ ████║██╔═══██╗     ██║██║
 ██║     ██║██╔████╔██║██║   ██║     ██║██║
 ██║     ██║██║╚██╔╝██║██║   ██║██   ██║██║
 ███████╗██║██║ ╚═╝ ██║╚██████╔╝╚█████╔╝██║
 ╚══════╝╚═╝╚═╝     ╚═╝ ╚═════╝  ╚════╝ ╚═╝
|==========================================|

Turning your favorite emojis into the world of ASCII

Releases License Contributors Merged PRs CI

📖 Introduction

Limoji is an open source tool that makes it easy to choose between hundreds of cool ASCII emoticons and share them with your friends, all done using the terminal!

All you have to do is pick the right one or let Limoji choose it for you!

Features

  • Hundreds of available emoticons to choose from
  • Automatic copy to the clipboard
  • Random emoticon generator
  • 100% free and open source
  • Lightweight and responsive
  • Wayland support
  • Tiny footprint (less than 30KB!)

⬇️ Installation

Debian / Ubuntu-based distributions (Officially supported)

Repository Automatic Updates How to install
GitHub ❌ Download the .deb file
Gemfury ✔️ Follow the instructions below

APT repository (Gemfury):

Run the following commands to add it:

# Add the repository
sudo echo "deb [trusted=yes] https://apt.fury.io/lefterisgar/ * *" > \
/etc/apt/sources.list.d/limoji.list

# Update the package indexes
sudo apt update

# Install Limoji
sudo apt install limoji

Other GNU/Linux distributions

Requirements:

  • xclip (X11) or wl-clipboard (Wayland)
  • git

To install it:

Depending on your session type (X11 or Wayland) you will need the appropriate package for copying items to the clipboard. It is recommended that you install both.

xclip (X11):

# Arch:
sudo pacman -S xclip

# Fedora:
sudo dnf install xclip

wl-clipboard (Wayland):

# Arch Linux:
sudo pacman -S wl-clipboard

# Fedora:
sudo dnf install wl-clipboard

Clone this repository:

git clone https://github.com/GEROGIANNIS/Limoji ~/Limoji

Add Limoji's directory to your path (NOTE: You must restart your session after that):

echo export PATH="~/Limoji:$PATH" | tee -a ~/.bashrc

You can update Limoji using:

cd ~/Limoji && git pull

📄 Usage

limoji <emoticon-name>

Example:

$ limoji happy
  [✓] happy was copied to the clipboard successfully:
  :‑)

Available commands

-e, --emoticons Show a list of the available emoticons
-h, --help Show this list
-i, --info Show info about the project
-r, --random Print a random emoticon
-v, --version Display Limoji's version

By default, limoji --version will query GitHub's API to check if a new version is available. If you wish to disable this check, use the --no-update-check flag:

$ limoji --version --no-update-check

# Shortened version:
$ limoji -v -nu

🔨 Development

Contributing to the project

  1. Fork Limoji
  2. Apply your proposed changes to the fork
  3. Open a pull request

Deployment

When everything is ready for a release, the version number needs to be incremented:

# Limoji 1.0.0

limoji_version="1.0.0"

Then run publish.sh:

./publish.sh

This script will automatically do the following:

  • Generate a changelog for the new release
  • Create the release commit
  • Tag the new release
  • Push everything to GitHub

GitHub actions is configured to build the package afterwards and draft a release.

💬 Todo:

  • Localization
  • Packaging
  • Help Page
  • Update README.md
  • Make A Release
  • Add Option To Receive Another Emoticon
  • Add Info Command