╦  ┬┌┐┌┌─┐┬ ┬┌─┐╔═╗┬─┐┌─┐┌─┐┌┬┐
║  │││││ ┬│ │├─┤║  ├┬┘├─┤├┤  │ 
╩═╝┴┘└┘└─┘└─┘┴ ┴╚═╝┴└─┴ ┴└   ┴ 

“LinguaCraft: Use it before you read to uncover unfamiliar words effortlessly.”

About

Your personalized companion for mastering foreign languages with confidence! This program helps you analyze texts, identify unfamiliar words, and prepare them for learning. With LinguaCraft, you can:

• Effortlessly process texts (from files only for now) to detect unknown words.
• Mark words as known or unknown, helping you focus on what truly matters.
• Retrieve translations and definitions for unfamiliar terms in your preferred language.
• Save result and build a growing list of known words for continuous learning.

Whether you’re preparing for exams, translating documents, or simply expanding your vocabulary, LinguaCraft makes language learning efficient, organized, and enjoyable. Dive into the world of words and watch your knowledge grow!

Getting Started

You can get started quickly like this:

pip install LinguaCraft

# Select your working directory
cd /to/your/work/dir

# Work with OpenAI GPT
export OPENAI_API_KEY=your-key-goes-here

# Create a text file with input text
touch input.txt

# Run LinguaCraft app
linguacraft 

See the installation instructions and other documentation on LLM setup for more details.

Usage

1. Run the application:

   linguacraft

2. Follow the on-screen instructions to input your text file.
3. Analyze the text to identify unknown words.
4. Review translations and definitions in the results screen.

Features

• Text Analysis: Process input texts to identify and categorize known and unknown words.
• Language Detection: Automatically detect the language of the input text.
• Translations & Definitions: Fetch translations and definitions for unknown words using various providers like OpenAI and Google Translator.
• User-Friendly Terminal Interface (TUI): Interactive screens for input, word lists, and results.
• Persistent Storage: Maintain a list of known words to enhance your learning over time.

Troubleshooting

If you encounter any issues while using LinguaCraft, refer to the app.log file for detailed error messages and logs.

cat app.log

Refer to Troubleshooting page for details.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/YourFeature

3. Commit your changes:

   git commit -m "Add Your Feature"

4. Push to the branch:

   git push origin feature/YourFeature

5. Create a Pull Request.

License

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

Contact

For any inquiries or support, please contact info@golodiuk.com.

---

© 2024 Dmytro Golodiuk