ASCII Art Generator

This project is an ASCII Art Generator that converts input text into ASCII art using different fonts and optional color coding and either outputs on the terminal or on a specific file of the user's choosing.

Prerequisites

This program was created entirely with Golang programming language so ensure your workstation supports golang version 1.18 or later before cloning the repository.

You can install golang from there website depending on the type of operating system your using at https://go.dev/doc/install and follow instructions on how to set-up

Table of Contents

Installation

  1. Clone the repository:

    git clone  https://github.com/jesee-kuya/ascii-art-output.git
  2. Navigate to the project directory:

    cd ascii-art-output
  3. Build the project:

    go build -o ascii-art-output

Usage

Run the binary with the required arguments:

./ascii-art-output -output=<text.txt>  "Your text here" <banner_file>

or this other optionl commands which are relevant to this program

this for base functionality

./ascii-art-output "your text here"

or this that specifies bannerfiles

./ascii-art-output "your text here" <banner_file>

or this that colors

./ascii-art-output -color=<color|color-code> "your text here" 

or letters to be colored

./ascii-art-output -color=<color|color-code> <letters to color> "your text here" 

All this are possible and can be combined with the output flag to output whatever the user's output he|she desires to the chosen text file i.e

./ascii-art-ouput -output=<text.txt> --color=<color> "Your text file" <banner_file>

Parameters

  • -banner_file: The font file to use (default: standard).
  • -color: The color to use for the text.
  • -letters: The specific letters to color.
  • "Your text here": The text you want to convert to ASCII art.
  • -output: The flag for the file the user chooses

Examples

Example 1: Basic Usage

./ascii-art-output -output=test.txt "Hello, World!" thinkertoy

cat -e test.txt
                                                    $
o  o     o o             o       o         o    o o $
|  |     | |             |       |         |    | | $
O--O o-o | | o-o         o   o   o o-o o-o |  o-O o $
|  | |-' | | | |          \ / \ /  | | |   | |  |   $
o  o o-o o o o-o o         o   o   o-o o   o  o-o O $
                 |                                  $
                                                    $

Contributing

We welcome contributions to improve the ASCII Art Generator. If you find a bug or have a feature request, please open an issue. If you would like to contribute code, please fork the repository and submit a pull request.

Steps to Contribute

  1. Fork the repository.
   https://github.com/jesee-kuya/ascii-art-output.git
  1. Create a new branch:
   git checkout -b feature-branch
  1. Make your changes.
  2. Commit your changes
git commit -am 'Add new feature
  1. Push to the branch
git push origin feature-branch
  1. Open a pull request

License

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

Brought to you by Jesee Kuya , James Muchiri and Fena Onditi