mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-17 13:12:08 +00:00
Add Hardware translation
This commit is contained in:
parent
d1ff8a2d70
commit
862edef9ce
@ -3,6 +3,7 @@
|
|||||||
* [בסיס QMK](he-il/README.md)
|
* [בסיס QMK](he-il/README.md)
|
||||||
* [מבוא לQMK](he-il/getting_started_introduction.md)
|
* [מבוא לQMK](he-il/getting_started_introduction.md)
|
||||||
* [שאלות נפוצות](he-il/faq.md)
|
* [שאלות נפוצות](he-il/faq.md)
|
||||||
|
* [חומרה](he-il/hardware.md)
|
||||||
|
|
||||||
**בשפה האנגלית**
|
**בשפה האנגלית**
|
||||||
* [המדריך המלא למתחילים](newbs.md)
|
* [המדריך המלא למתחילים](newbs.md)
|
||||||
|
64
docs/he-il/documentation_best_practices.md
Normal file
64
docs/he-il/documentation_best_practices.md
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
# Documentation Best Practices
|
||||||
|
|
||||||
|
This page exists to document best practices when writing documentation for QMK. Following these guidelines will help to keep a consistent tone and style, which will in turn help other people more easily understand QMK.
|
||||||
|
|
||||||
|
# Page Opening
|
||||||
|
|
||||||
|
Your documentation page should generally start with an H1 heading, followed by a 1 paragraph description of what the user will find on this page. Keep in mind that this heading and paragraph will sit next to the Table of Contents, so keep the heading short and avoid long strings with no whitespace.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```
|
||||||
|
# My Page Title
|
||||||
|
|
||||||
|
This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone.
|
||||||
|
```
|
||||||
|
|
||||||
|
# Headings
|
||||||
|
|
||||||
|
Your page should generally have multiple "H1" headings. Only H1 and H2 headings will included in the Table of Contents, so plan them out appropriately. Excess width should be avoided in H1 and H2 headings to prevent the Table of Contents from getting too wide.
|
||||||
|
|
||||||
|
# Styled Hint Blocks
|
||||||
|
|
||||||
|
You can have styled hint blocks drawn around text to draw attention to it.
|
||||||
|
|
||||||
|
### Important
|
||||||
|
|
||||||
|
```
|
||||||
|
!> This is important
|
||||||
|
```
|
||||||
|
|
||||||
|
Renders as:
|
||||||
|
|
||||||
|
!> This is important
|
||||||
|
|
||||||
|
### General Tips
|
||||||
|
|
||||||
|
```
|
||||||
|
?> This is a helpful tip.
|
||||||
|
```
|
||||||
|
|
||||||
|
Renders as:
|
||||||
|
|
||||||
|
?> This is a helpful tip.
|
||||||
|
|
||||||
|
|
||||||
|
# Documenting Features
|
||||||
|
|
||||||
|
If you create a new feature for QMK, create a documentation page for it. It doesn't have to be very long, a few sentences describing your feature and a table listing any relevant keycodes is enough. Here is a basic template:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# My Cool Feature
|
||||||
|
|
||||||
|
This page describes my cool feature. You can use my cool feature to make coffee and order cream and sugar to be delivered via drone.
|
||||||
|
|
||||||
|
## My Cool Feature Keycodes
|
||||||
|
|
||||||
|
|Long Name|Short Name|Description|
|
||||||
|
|---------|----------|-----------|
|
||||||
|
|KC_COFFEE||Make Coffee|
|
||||||
|
|KC_CREAM||Order Cream|
|
||||||
|
|KC_SUGAR||Order Sugar|
|
||||||
|
```
|
||||||
|
|
||||||
|
Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_sidebar.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page.
|
8
docs/he-il/hardware.md
Normal file
8
docs/he-il/hardware.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# חומרה
|
||||||
|
|
||||||
|
QMK רצה על מגוון של חומרות. אם המעבד שלך יכול להיות ממוקד (מטורגט) ע״י [LUFA](http://www.fourwalledcubicle.com/LUFA.php) או [ChibiOS](http://www.chibios.com) כנראה שתוכל לגרום ל QMK לרוץ על המעבד. קטע זה מדבר על הרצת QMK, ותקשורת עם, סוגים שונים של חומרות.
|
||||||
|
|
||||||
|
* [מדריך למקלדת](hardware_keyboard_guidelines.md)
|
||||||
|
* [מעבדי AVR](hardware_avr.md)
|
||||||
|
* מעבדי ARM (TBD)
|
||||||
|
* [מנהלי התקנים](hardware_drivers.md)
|
28
docs/he-il/quantum_keycodes.md
Normal file
28
docs/he-il/quantum_keycodes.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# קודי מקלדת Quantum
|
||||||
|
|
||||||
|
קודי מקלדת Quantum מאפשרים התאמה נוחה יותר של מיפוי המקשים שלך מעבר למה שהבסיסי מאפשר, ללא צורך בהגדרת של פעולות מותאמות אישית.
|
||||||
|
|
||||||
|
כל קודי המקלדת בתוך quantum הם מספרים בין `0x0000` ֿֿֿ ל-`0xFFFF`. בתוך הקובץ `keymap.c` זה עלול להראות כאילו יש לך פונקציות ומקרים יחודיים נוספים, אבל בסופו של דבר הקדם-מעבד של שפת C יתרגם אלה לתוך מספר יחיד בין 4 בתים. QMK שמרה את מרחב הכתובות בין `0x0000` עד ל- `0x00FF` עבור קודי מקשים סטנדרטיים. קודי מקשים אלה, כגון `KC_A`, `KC_1`, ו- `KC_LCTL`, אשר מתארים מקשים בסיסיים מוגדרים בתוך USB HID specification.
|
||||||
|
|
||||||
|
בעמודו זה יש לנו את קודי המקשים מתועדים בין `0x00FF` ֿֿ ל- `0xFFFF` אשר משומשים בשביל לממש יכולות מתקדמות של quantum. אם תגדירו קודי מקשים משלכם, הם יתווספו לתוך המרחב הזה גם כן.
|
||||||
|
|
||||||
|
## קודי מקשים של QMK
|
||||||
|
|
||||||
|
|Key |Aliases |Description |
|
||||||
|
|---------------|-----------|---------------------------------------------------------------------|
|
||||||
|
|`RESET` | |Put the keyboard into DFU mode for flashing |
|
||||||
|
|`DEBUG` | |Toggle debug mode |
|
||||||
|
|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
|
||||||
|
|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>`</code> when pressed with Shift or GUI|
|
||||||
|
|`KC_LSPO` | |Left Shift when held, `(` when tapped |
|
||||||
|
|`KC_RSPC` | |Right Shift when held, `)` when tapped |
|
||||||
|
|`KC_LCPO` | |Left Control when held, `(` when tapped |
|
||||||
|
|`KC_RCPC` | |Right Control when held, `)` when tapped |
|
||||||
|
|`KC_LAPO` | |Left Alt when held, `(` when tapped |
|
||||||
|
|`KC_RAPC` | |Right Alt when held, `)` when tapped |
|
||||||
|
|`KC_SFTENT` | |Right Shift when held, Enter when tapped |
|
||||||
|
|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
|
||||||
|
|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
|
||||||
|
|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) |
|
||||||
|
|`M(n)` | |Call macro `n` |
|
||||||
|
|`MACROTAP(n)` | |Macro-tap `n` idk FIXME |
|
Loading…
Reference in New Issue
Block a user