Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.39 KB

README.md

File metadata and controls

90 lines (56 loc) · 3.39 KB

Arutairu - Learn Japanese Vocabulary

Welcome to Arutairu, an open-source Android app designed to help users learn Japanese vocabulary in a fun and efficient way. This app is perfect for anyone interested in improving their Japanese language skills, whether for travel, watching anime, or simply for personal growth.

About the Project

Passionate about learning languages, and unsatisfied with traditional language learning apps, I developed Arutairu to meet my own needs. As my requirements were met and my time to improve the app diminished, I decided to make Arutairu open-source. This gives the app a fresh new start and the chance to evolve with contributions from the community.

Features

  • Vocabulary Lists & JLPT Preparation: Learn Japanese through extensive vocabulary lists and prepare for the JLPT with focused word sets.
  • Pronunciation & Romaji: Use the Text To Speech service for pronunciation help and read words in Romaji.
  • Hiragana, Katakana, Kanji: Start with Hiragana, move to Katakana, and finally Kanji as per your comfort level. Vocabulary lists are available in kana and kanji.
  • Offline Access: Learn anywhere, anytime, without needing an internet connection.
  • Language Support: Available in both French and English.
  • Hands-Free Mode: Learn on the go without needing to look at your screen, perfect for use while commuting or exercising.

Getting Started

Prerequisites

To run the application, you will need:

  • Android Studio
  • An Android device or emulator

Installation

  1. Clone the repository: git clone https://github.com/yourusername/arutairu.git
  2. Open the project in Android Studio.
  3. Build and run the project on your device or emulator.

Contributing

We welcome contributions from everyone! Here’s how you can help:

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Provide as much detail as possible, including steps to reproduce the bug and screenshots if applicable.

Suggesting Features

Have an idea for a new feature? We’d love to hear it! Open an issue with your suggestion and we’ll discuss it.

Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/new-feature).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature/new-feature).
  6. Open a pull request.

Coding Guidelines

  • Write clear, concise commit messages.
  • Ensure your code is well-documented.
  • Follow the existing code style and conventions.

Roadmap

Future improvements and features include:

  • Additional vocabulary lists.
  • Performance & stability enhancement.
  • More advanced learning tools and quizzes.
  • Improved user interface and user experience.
  • Community-driven content and updates.

License

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

Acknowledgements

  • Thanks to all the contributors who help make this project better.
  • Special thanks to the open-source community for providing tools and libraries that make this app possible.

Contact

If you have any questions or need further assistance, feel free to contact us at [email protected] or join the discussion on our GitHub page.

Support Arutairu!

Help make learning Japanese more accessible and support me! Your contributions and support are greatly appreciated.


Happy learning! 🎉