From 3a68f35cc4d841d527285437da3eae9b5f803cd7 Mon Sep 17 00:00:00 2001 From: GuyK Date: Thu, 24 Oct 2019 11:00:08 +0300 Subject: [PATCH] Code sections should be alligned to the left --- docs/he-il/documentation_best_practices.md | 2 ++ docs/he-il/getting_started_github.md | 4 ++++ docs/he-il/getting_started_introduction.md | 4 ++++ docs/he-il/proton_c_conversion.md | 11 ++++++----- docs/he-il/quantum_keycodes.md | 3 ++- 5 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/he-il/documentation_best_practices.md b/docs/he-il/documentation_best_practices.md index 90c4a137a04..385e512170f 100644 --- a/docs/he-il/documentation_best_practices.md +++ b/docs/he-il/documentation_best_practices.md @@ -49,6 +49,7 @@ אם יוצרים יכולת חדשה ב QMK, צרו עמוד תיעוד עבורה. העמוד לא צריך להיות ארוך במיוחד, מספר משפטים המתארים את היכולת (פיצ׳ר) וטבלה המתארת קודי מקשים רלוונטיים זה מספיק. הנה דוגמה בסיסית: +
```markdown # הפיצ׳ר המגניב שלי @@ -62,6 +63,7 @@ |KC_CREAM||Order Cream| |KC_SUGAR||Order Sugar| ``` +
מקמו את התיעוד שלכם בתוך `docs/feature_.md`, והוסיפו קישור לקובץ זה במקום המתאים ב `docs/_sidebar.md`. אם הוספתם קודי מקשים נוספים, תקפידו להוסיף אותם ל- `docs/keycodes.md` עם לינק לעמוד היכולת שלכם. \ No newline at end of file diff --git a/docs/he-il/getting_started_github.md b/docs/he-il/getting_started_github.md index 2dae57fc3de..048f4c946dc 100644 --- a/docs/he-il/getting_started_github.md +++ b/docs/he-il/getting_started_github.md @@ -19,6 +19,7 @@ Github עלול להיות קצת טריקי למי שלא מכיר את העב מכאן והלאה, הקיש `git clone ` בשורת הפקודה והדביקו את הלינק שלכם: +
``` user@computer:~$ git clone https://github.com/whoeveryouare/qmk_firmware.git Cloning into 'qmk_firmware'... @@ -29,9 +30,11 @@ Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. Resolving deltas: 100% (29362/29362), done. Checking out files: 100% (2799/2799), done. ``` +
כעת, יש לכם את ה-fork של QMK על המכונה המקומית שלכם ואתם יכולים להוסיף את מיפויי המקשים שלכם, לקמפל את הפרוייקט ולצרוב אותו על הלוח שלכם. כשאתם שלמים עם השינוי שעשיתם, תוכלו להוסיף, לבצע פעולת commit ולדחוף את השינויים ל-fork שלכם באופן הבא: +
``` user@computer:~$ git add . user@computer:~$ git commit -m "adding my keymap" @@ -48,6 +51,7 @@ remote: Resolving deltas: 100% (1/1), completed with 1 local objects. To https://github.com/whoeveryouare/qmk_firmware.git + 20043e64...7da94ac5 master -> master ``` +
השינויים שלכם יופיעו ב-fork שלכם ב-GitHub - אם תחזרו לשם (`https://github.com//qmk_firmware`), תוכלו ליצור "Pull Request חדש" ע״י הקשה על הכפתור הבא: diff --git a/docs/he-il/getting_started_introduction.md b/docs/he-il/getting_started_introduction.md index 9a86caed1fa..64ec3b08fe1 100644 --- a/docs/he-il/getting_started_introduction.md +++ b/docs/he-il/getting_started_introduction.md @@ -47,13 +47,16 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req מערכת הבילד אוטומטית בוחרת את קובץ ההגדרות לפי הסדר הנ״ל. אם רוצים לדרוס הגדרה מסויימת שהוגדרה בקובץ `config.h` קודם, ראשית תצטרכו להשתמש בקוד מוכן עבור ההגדרות שאתם רוצים לשנות. +
``` #pragma once ``` +
כדי לדרוס הגדרות מקובץ `config.h` קודם, אתם מוכרחים להשתמש בפקודת `#undef` ואז שוב `#define`. דוגמה לקוד כזה נראית כך: +
``` #pragma once @@ -61,4 +64,5 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req #undef MY_SETTING #define MY_SETTING 4 ``` +
\ No newline at end of file diff --git a/docs/he-il/proton_c_conversion.md b/docs/he-il/proton_c_conversion.md index 8d0a5b4debe..167f934e32e 100644 --- a/docs/he-il/proton_c_conversion.md +++ b/docs/he-il/proton_c_conversion.md @@ -2,22 +2,23 @@ # המרה של לוח להשתמש ב-Proton C אם לוח נתמך ב-QMK משתמש בלוח Pro Micro (או כל לוח נתמך) ואתם רוצים להשתמש ב-Proton C, ניתן לייצר את החומרה ע"י הוספה של הפקודה `CONVERT_TO_PROTON_C=yes` (או `CTPC=yes`) לפקודת make, כמו כאן: - +
make 40percentclub/mf68:default CTPC=yes - +
ניתן להוסיף את אותו ארגומנט לקובץ `rules.mk` במיפוי המקשים שלכם, שתיצור את אותה התוצאה. הדבר חושף את דגל `CONVERT_TO_PROTON_C` שניתן להשתמש בו בקוד שלכם באמצעות פקודת `#ifdef`, כמו כאן: - +
#ifdef CONVERT_TO_PROTON_C // Proton C code #else // Pro Micro code #endif - +
לפני שתצליחו לקמפל, יכול להיות שתקבלו שגיאות שונות לגבי `PORTB/DDRB`, וכו' שלא הוגדרו, אם כך, תצטרכו להמיר את קודי המקלדת להשתמש ב - [בקרי GPIO](internals_gpio_control.md) שיעבדו עבור ARM וגם AVR. הדבר לא אמור להשפיע על הבילדים של AVR בכלל. ל-Proton C יש רק מנורת LED אחת על הלוח (C13), וכברירת מחדל, TXLED (D5) ממופה אליו. אם תרצו במקום, למפות אליו את RXLED (B0), הוסיפו את השורה הבא לקובץ `config.h`: - +
#define CONVERT_TO_PROTON_C_RXLED +
\ No newline at end of file diff --git a/docs/he-il/quantum_keycodes.md b/docs/he-il/quantum_keycodes.md index 0bec3712442..f7b79bbbdfc 100644 --- a/docs/he-il/quantum_keycodes.md +++ b/docs/he-il/quantum_keycodes.md @@ -8,7 +8,7 @@ בעמודו זה יש לנו את קודי המקשים מתועדים בין `0x00FF` ֿֿ ל- `0xFFFF` אשר משומשים בשביל לממש יכולות מתקדמות של quantum. אם תגדירו קודי מקשים משלכם, הם יתווספו לתוך המרחב הזה גם כן. ## קודי מקשים של QMK - +
|Key |Aliases |Description | |---------------|-----------|---------------------------------------------------------------------| |`RESET` | |Put the keyboard into DFU mode for flashing | @@ -27,4 +27,5 @@ |`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) | |`M(n)` | |Call macro `n` | |`MACROTAP(n)` | |Macro-tap `n` idk FIXME | +
\ No newline at end of file