Skip to content

Commit

Permalink
docs: Update README with enhanced features and usage examples for gre…
Browse files Browse the repository at this point in the history
…entext CLI
  • Loading branch information
jasonuc committed Dec 9, 2024
1 parent 753ddff commit befa11f
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 12 deletions.
61 changes: 49 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Green-Text Meme Generator CLI
# greentext CLI

The Green-Text Meme Generator CLI is a command-line tool built with Go that allows users to create classic green-text memes with ease. It uses simple inputs and generates meme-styled output, making it perfect for meme enthusiasts.
The Green-Text Meme Generator CLI is a command-line tool built with Go that lets you create classic green-text memes with ease.

## Features

- **Customizable Inputs**: Easily specify your own green-text meme content.
- **Random Meme Generator**: Generate random green-text memes for fun.
- **Fast and Lightweight**: Powered by Go for high performance and low memory usage.
- **Output Options**: Save generated memes as text files or display them directly in the terminal.
- **Portable**: Works seamlessly across macOS, Linux, and Windows.
- **Customizable Inputs**: Write your own green-text stories with ease.
- **Thumbnail Support**: Add an image to your meme, or use the built-in placeholder if you're feeling minimalist.
- **Fast and Lightweight**: Powered by Go, because performance matters even when making memes.
- **Formatted Output**: Saves memes as beautifully formatted PNGs, ready for sharing.

## Installation

Expand All @@ -28,23 +27,61 @@ The Green-Text Meme Generator CLI is a command-line tool built with Go that allo
4. Build the CLI tool:

```bash
go build -o greentext
go build -o bin/greentext .
```

5. Run the tool:

```bash
./greentext
bin/greentext -h
```

## Usage

Here’s how you can generate your very own green-text meme:

### Example Command

```bash
bin/greentext -l 5 -t ./tfw.png -o meme.png
```

- `-l`: Number of lines to include in the green-text.
- `-t`: Path to a thumbnail image (optional).
- `-o`: Output file name.

### Example Input

When prompted, enter your meme lines:

```text
> be me
> decide to write a meme generator in Go
> "how hard could image manipulation be?"
> 3 hours in, still trying to draw a rectangle
> find 5 different libraries that almost do what I want
> none of them support rounded corners
> consider switching to Python
> remember I already told everyone Go is the best
> silently suffer
> finally get it working
> "go build -o bin/greentext"
> runtime panic: freetype called with nil font
> tfw image manipulation in Go makes you question life
```

### Example Output

This command will generate a beautiful green-text meme like this:

![Example Meme](example-meme.png)

## Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
Contributions are welcome! Whether you find a bug, have an idea for a new feature, or just want to improve the documentation, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

Happy meme-ing! 🚀
Binary file added example-meme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit befa11f

Please # to comment.