noppadol-assava / langplusplus

A collection of code editing tools with support for non-English languages

lang++

A collection of code editing tools with support for non-English languages.

📝 Table of Contents

• Purpose
• Goals
• Instructions
  • Installation
  • Usage
• Contributing
• Dependencies / Built Using
• License
• Author

✔️ Purpose

Most widely-used programming languages are English-based, making the learning process difficult for many non-English speakers intending to use these languages in their studies and/or careers. lang++ addresses this issue using the translation functionality shown above.

🥅 Goals

• Expand language-programming language translation database
  • As of now, lang++ supports 4 lang-prog lang combinations (Chinese, Spanish, and Japanese to C++, Chinese to Java, and Chinese to Swift)
• Incorporate machine learning / natural language processing
  • Improve translation accuracy
  • Consider context when suggesting autocompletions
  • Better account for evolution/change of programming languages over time
• Potential to be expanded into plugins, extensions, etc.
  • Will better serve people looking for occasional language help
  • Could function similar to dictionary

See issues for detailed tasks and descriptions.

🗒️ Instructions

To see the online editor demo in action, follow these steps:

⬇️ Installation

1. Download ACE Editor files from ACE Github (See "Dependencies / Built Using" below)
2. Download lang++ repository.

🏃 Usage

1. Open index.html using Notepad or any other text editor / code editor / IDE.
2. Select your preferred language and programming language.
3. Type in the text editor in your preferred language.

index.html in Google Chrome:

You can find translations in the "translations" folder, in the form of .csv files.

👥 Contributing

lang++ provides various opportunities for contributing, including:

• Expanding the database of translations
• Improving the demo code
• Integrating machine learning

We greatly appreciate contributions; yours will not go unnoticed. Please visit contributors to view a list of contributors this project. To learn more about contributing to lang++, visit CONTRIBUTING.md and CODE_OF_CONDUCT.md, and join the Team Slack.

Furthermore, feel free to use lang++ (in accordance with the license) in your own projects, such as plugins or extensions for preexisting IDEs.

🛠️ Dependencies / Built Using

• ACE Editor - online editor demo - ACE Editor Github Repo, Official Website
• D3 - parsing .csv data - D3 Github Repo, Official Website

⚖️ License

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

✍️ Author

• Anne Li - Initial work - fibanneacci

View contributors to this project.