An open API service indexing awesome lists of open source software.

https://github.com/srilakshmikanthanp/libfiglet

Use this library to Generate large text out of ordinary text akin to popular program FIGlet with C++ Easily!
https://github.com/srilakshmikanthanp/libfiglet

cpp figlet

Last synced: about 2 months ago
JSON representation

Use this library to Generate large text out of ordinary text akin to popular program FIGlet with C++ Easily!

Awesome Lists containing this project

README

        

libfiglet


Figlet For C++


Explore the docs »


Report Bug
·
Request Feature

Table of Contents




  1. About The Project


  2. Getting Started


  3. Usage

  4. Contributing

  5. License

  6. Contact

## About The Project

This is Figlet Library for C++ to generate Large text out of ordinary text like this,

~~~Figlet
_ _ _ _ ____
| | | | ___| | | ___ / ___| _ _
| |_| |/ _ \ | |/ _ \ | | _| |_ _| |_
| _ | __/ | | (_) | | |__|_ _|_ _|
|_| |_|\___|_|_|\___( ) \____||_| |_|
|/
~~~

## Getting Started

### Project Scope

This Project currently only works With ASCII Characters and it currently does not support Unicode Characters (at least flf font parser).

### Installation

Starting with version 1.3.0 the library is no longer header-only But you generate the header file using quom and then you can use it in your project.

1. Clone the repo from the GitHub

~~~sh
git clone https://github.com/srilakshmikanthanp/libfiglet.git
~~~

2. Install the quom with pip

~~~sh
pip install --user quom
~~~

3. Generate Include Files

~~~sh
quom .\src\srilakshmikanthanp\libfiglet.hpp .\dist\libfiglet.hpp
~~~

4. Use the header file in your project

## Usage

Usage of This Library is very easy a Hello C++ would be,

~~~cpp
#include "libfiglet.hpp"
#include

using namespace srilakshmikanthanp::libfiglet;

int main()
{
const figlet figlet(flf_font::make_shared("./path/to/font"), smushed::make_shared());
std::cout << figlet("Hello, C++");
}

~~~

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Project Link: [https://github.com/srilakshmikanthanp/libfiglet](https://github.com/srilakshmikanthanp/libfiglet)