README.md
מה היא קושחת QMK?
QMK (Quantum Mechanical Keyboard) היא קהילת קוד פתוח (open source) שמתחזקת את קושחת QMK, QMK Toolbox, qmk.fm, והמסמכים המתאימים. קושחת QMK היא קושחה עבור מקלדות המבוססת על tmk_keyboard עם כמה תוספות עבור בקרי Atmel AVR ובאופן ספציפי יותר - מוצרי OLKB, מקלדת ErgoDox EZ, וגם מוצרי Clueboard. בנוסף, הקושחה עברה פורט עבור שבבי ARM באמצעות ChibiOS. ניתן להשתמש בה על מנת להפעיל את מקלדות ה PCB המקוסטמות שלך.
איך להשיג אותה
אם אתם מתכננים לתרום מיפוי מקשים, מקלדת או יכולת ל QMK, הדבר הקל ביותר הוא לעשות פורק לריפו בGitHub, ולעשות קלון לריפו בסביבה המקומית ושם לבצע את השינויים שלכם, לדחוף אותם ולפתוח Pull Request מהפורק שלך.
אחרת, אפשר להוריד את הקושחה באופן ישיר (zip, tar), או לשכפל אותה באמצעות git (git@github.com:qmk/qmk_firmware.git), או https (https://github.com/qmk/qmk_firmware.git).
איך לקמפל
לפני שתצליחו לקמפל, תדרשו להתקין סביבה עבור פיתוח AVR ו/או ARM. ברגע שהדבר בוצע, תוכלו להריץ פקודת make כדי לבנות מקלדת ומיפוי עם התחביר הבא:
make planck/rev4:default
כך תוכלו לבנות את גרסא rev4 של ה planck עם מיפוי ברירת המחדל (default). לא כל המקלדות בעלות גרסאות (נקרא גם תת-פרוייקט או תיקייה), במקרה כזה, אפשר להריץ את הפקודה הבאה:
make preonic:default
איך להתאים
לQMK יש המון יכולות שאפשר לנווט בהן, וכמות נכבדת של תיעוד ודוקומנטציה בה אפשר לנבור. רוב הפיצ׳רים באים לידי ביטוי על ידי שינוי מיפוי המקלדת ושינוי קודי המקשים.