pmt: ADD-LANGUAGES

ADD-LANGUAGES.md

@@ -0,0 +1,135 @@
+### Add a new language to pmt (guide)
+
+On this page, I will tell you how to add languages to pmt. This is not a difficult thing :)
+
+##### Send ready stuff
+ - Send ready translations via pull requests. After making the necessary checks, if there is no problem, I will accept it.
+ - If there is an error, I will mention it in the pull request comments.
+ - Once you accept it, I (YZBruh) will implement the rest of the necessary things.
+ - It may take 5 days for me to notice :P
+
+##### Little important notes
+ - You don't have to be a professional to do this thing.
+ - There will be only one place you need to pay attention to, I will explain it.
+ - There is no need to know C.
+ - You can edit existing translations.
+ - You may need ready pmt to understand some things.
+ - If you are on an x86 PC, you can compile and use it, but the functions will never work.
+
+##### Understanding general logic
+ All the texts (strings) in pmt are like variables in bash. I mean:
+
+ ```
+ Bash
+     export missing_operand="missing operand."
+
+     APPLYING:
+          ~ $ echo -n "$missing_operand\n" # for more detail I used the -n argument
+          missing operand
+          ~ $ 
+          
+
+ C / C++
+     const char* _Nonnull missing_operand = "missing operand.";
+     const std::string missing_operand = "missing operand.";
+
+     APPLYING (C / C++):
+          printf("%s\n", missing_operand); // Move to new line with '\n' character
+          std::cout << missing_operand << std::endl; // Move to new line with std::endl
+ ```
+
+ For example, let's take the output directly in pmt without any arguments and process the variables and structures behind the work.
+
+ ```
+ Shell
+      ~ $ pmt
+      pmt: missing operand
+      Try `pmt --help' for more information.
+      ~ $
+
+ Code pieces (C)
+      struct pmt_langdb_general en = {
+          // other translations
+          .missing_operand = "missing operand";
+          .try_h = "Try";
+          .for_more = "for more information";
+          // other translations
+      }
+
+      // pmt code functions [ logging ]
+      LOGE("%s\n%s `%s --help' %s.\n, missing_operand, try_h, argv[0], for_more); // LOGE is error logger (pmt). argv[0] = execution name
+ ```
+
+In short, there are variables for texts. And I made these dynamic by using [struct](https://chatgpt.com/share/a798b57c-7e29-4b17-8887-f230414e57bd) method in C. You just need to add translation :)
+
+##### Translating main program texts (relevant part)
+
+ - Let's open our jni/languages.c source file.
+ - Now, let's create the translation with the ready-made struct structure (see jni/include/pmt-stringkeys.h for the structure).
+ ```
+ // main
+ struct pmt_langdb_general <LANGUAGE_PREFIX> = { // LANGUAGE_PREFIX must be the corresponding abbreviation of the language in English. For example, it's like en in English.
+      // translations
+ }
+
+ // example
+ struct pmt_langdb_general en = {
+      // translation
+ }
+ ```
+ - We need to add some information about the language.
+ ```
+ struct pmt_langdb_general <LANGUAGE_PREFIX> = {
+      .lang_by_s = // Names of those who made the translation. It's up to you. Do you use & between more than one person?
+      .language = // Language name. For example English
+      .lang_prefix = // Language prefix. For example en
+      // other translations
+ }
+
+ // example
+ struct pmt_langdb_general en = {
+      .lang_by_s = "YZBruh";
+      .language = "English";
+      .lang_prefix = "en";
+      // other translations
+ }
+
+ // CRITIC WARNING: Do not add ';' to the end of the last translation text. But others always
+ ```
+ - Now do the others :)
+ - Now let me explain the documentation...
+
+##### Document texts translation (relevant part)
+
+ - Let's open our jni/languages.c source file.
+ - Now, let's create the translation with the ready-made struct structure (see jni/include/pmt-stringkeys.h for the structure).
+ ```
+ struct pmt_langdb_docs <LANGUAGE_PREFIX>_docs = {
+      // translations
+ }
+
+ // example
+ struct pmt_langdb_docs en_docs = {
+      // translations
+ }
+ ```
+ - Make translations by taking examples from existing ones. And definitely do it regularly by getting help message from pmt :D
+
+##### General things to do in translation
+
+ - Open jni/languages.c
+ - Go down a bit...
+```
+char* pmt_langdb_langs[] = {
+    "en",
+    "tr"
+};
+// Add the language you are translating into these existing language prefixes. I will fix the errors here (if there is an error)
+
+int pmt_langdb_total = <NUM>; // add one to the existing one and write (replacing with existing)
+int pmt_langdb_ctrl = <NUM>; // add one to the existing one and write (replacing with existing)
+```
+
+##### Notes
+ - Apologies for the crappy current language control structure :(
+ - You can ask your questions: <t.me/YZBruh>