💡 acrogen

acrogen (Acronym Generator) is a fast and efficient Command Line Interface (CLI) tool written in Go, designed to generate acronyms and abbreviations from user query.

---

✨ Features

• 🇷🇺 Russian language is supported (for generation, not for UI)
• 🇬🇧 English language is supported (UI, generation)
• 🖥️ Intuitive CLI
• 🛠️ Easy to build and run with makefile
• ⚡ High performance
• 📦 Modular Architecture:
• 🔀 Concurrency is used

---

🚀 Getting started

Prerequisites

To build and run this project, you need:

• Go (see version above)
• Make (optional, for quick build and run)

Installation and setup

1. ⬇️ Clone the repository:

git clone https://github.com
cd acrogen

2. ⚙️ Compile the project using the Makefile:

make build

This will generate an executable binary in the root directory.

---

⌨️ Usage

Run the acrogen:

make run

You can run tests with code coverage (PACKAGES variable is optional):

make test PACKAGES=<list of package names>

To see tests info in details enter the following command:

make testv PACKAGES=<list of package names>

After runnung tests you can see coverage report in details. Enter the following command:

make open_coverage_report

---

📂 Project structure

The repository follows a clean and structured package layout:

• makefile — Make commands to build and run quickly
• ag/ — core of acronym representation and generation
• algo/ — common algorithms used for generation
• cont/ — some custom containers
• data/ — source data, russian and english dictionaries, default storage for log and output files
• fio/ — file Input/Output subsystem (reading source data and writing results)
• ui/ — user CLI, interaction components
• utils/ — common helpers and utility functions

---

📄 License

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

---

🤝 Feedback

You can contact with me using info from my Github profile

If you find 'acrogen' helpful, please give me a star ⭐