sadr0b0t / babbler_h

GNU Lesser General Public License v3.0
7 stars 1 forks source link

Make library more international commiters friendly #14

Open chaos-adept opened 7 years ago

chaos-adept commented 7 years ago

i am exploring your library for using it for making channel between, arduino and android, and i have questions, why this repository and source code have Russian language, it could reduce amount of possible committers.

Are there any reasons to use Russian for communications in the github?

sadr0b0t commented 7 years ago

Hello, thank's for your interest.

Generally, there are 2 reasons, both make sense for me

1) The 1st one is historical+technical. I've been using example code and some parts of internal code of my projects in localized blog posts and offline lessons in Russian, so I had to translate the comments to Russian and as soon as I did not want to lose them I have started to make comments in all my source code on 2 languages English+Russian where possible. After some time Russian became a priority, but I still try to make bilingual comments - at 1st priority for public examples and API documentation, 2nd priority - internal comments in source code. Most comments in this particular project are currently in Russian, but I have plans to translate more comments and docs also to English when return to the problem of creating nice looking API documentation (readme on the main page is far from being perfect). I hope to find some tools that would generate API docs from JS source code (a kind of javadoc for js) and I hope it would support some methods to work with multiple languages to document same project.

2) The 2nd reason is philosophical+experimental. I am going to use Russian language wherever I want just because I feel enough comfortable with it, but I also want to leave an option for English (and any other language) to be used in the same project at the same time. From one side, this might bring additional problems and some mess to source code, but I think most of them can be solved with some technical solutions (like special markdown for source code comments, automatic translation plugins for ide etc). So, as an experiment, I want to see, what would be the problems for multilingual codebase and work out some guides to solve or avoid common cases.

For the channel between arduino and android you might want to see some of my old projects in this repo: https://github.com/1i7/snippets

This project is for direct communication via wifi: https://github.com/1i7/snippets/tree/master/chipkit-server-wifi

This project is for USB accessory communication mode: https://github.com/1i7/snippets/tree/master/chipkit-android-usb

The microcontroller board code would only work on ChipKIT boards with PIC32 chip (won't run on classical Arduino with AVR), but Android code part might be useful.

chaos-adept commented 7 years ago

ok thanks, it is more clear now