qmk-firmware/.gitignore

# Junk files
*.bak
*.swp
*~
.DS_Store
._*

# Merge files
*.orig
*.rej

# Build artifacts
.clang_complete
.build/
*.elf
*.log
*.lss
*.lst
*.map
*.o
*.a
*.so
*.dylib
*.dll
*.la
*.stackdump
*.sym
index.html
firmware_list.json

# QMK-specific
api_data/v1
quantum/version.h
*.bin
*.eep
*.hex
*.qmk
*.uf2

# DD config at wrong location
/keyboards/**/keymaps/*/info.json
/keyboards/**/keymaps/*/keyboard.json

# Old-style QMK Makefiles
/keyboards/**/Makefile

# kbfirmware....
/keyboards/**/kb.h
/keyboards/**/kb.c

# Eclipse/PyCharm/Other IDE Settings
*.iml
.browse.VC.db*
.cproject
.idea
.idea/
.project
.settings/

# ?
.dep
.history/
build/
cmake-build-debug
CMakeLists.txt
*.pdf

# Let these ones be user specific, since we have so many different configurations
*.code-workspace
.stfolder
.tags
.vscode/c_cpp_properties.json
.vscode/ipch/
.vscode/last.sql
.vscode/launch.json
.vscode/tasks.json
.vscode/temp.sql
tags

# Ignore image/font files
*.bmp
*.wbmp
*.gif
*.jpg
*.jpeg
*.png
*.apng
*.mng
*.svg
*.webp
*.webm
*.avi
*.mp4
*.mpeg
*.ttf
*.otf

# Things Travis sees
/.vs
id_rsa_*
secrets.tar

# Python things
__pycache__
.python-version
.venv

# Prerequisites for updating ChibiOS
/util/fmpp*

# Allow to exist but don't include it in the repo
user_song_list.h

# clangd
compile_commands.json
.clangd/
.cache/

# VIA(L) files that don't belong in QMK repo
via*.json
/keyboards/**/keymaps/via/*
/keyboards/**/keymaps/vial/*
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Junk files`
			`*.bak`
			`*.swp`
			`*~`
			`.DS_Store`
Remove old .gitignore entry. Add more macOS junk exclusions. (#16167) 2022-02-02 12:36:37 +08:00			`._*`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00
Add .orig to .gitignore (#17626) 2022-07-17 02:38:56 +08:00			`# Merge files`
			`*.orig`
			`*.rej`

Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Build artifacts`
			`.clang_complete`
			`.build/`
change file name. 2010-08-10 12:45:28 +08:00			`*.elf`
Stops explorer.exe from being started with admin privilieges (#373) 2016-06-03 01:00:44 +08:00			`*.log`
change file name. 2010-08-10 12:45:28 +08:00			`*.lss`
			`*.lst`
			`*.map`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`*.o`
Add more unwanted compilation output files to `.gitignore`. (#22894) 2024-01-12 20:08:11 +08:00			`*.a`
			`*.so`
			`*.dylib`
			`*.dll`
			`*.la`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`*.stackdump`
change file name. 2010-08-10 12:45:28 +08:00			`*.sym`
[CI] Add index page generator. (#23737) 2024-07-11 21:43:26 +08:00			`index.html`
Add json index of files to CI uploads (#24097) 2024-07-12 06:48:43 +08:00			`firmware_list.json`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00
			`# QMK-specific`
Generate api data on each push (#10609) * add new qmk generate-api command, to generate a complete set of API data. * Generate api data and push it to the keyboard repo * fix typo * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> * fixup api workflow * remove file-changes-action * use a more mainstream github action * fix yaml error * Apply suggestions from code review Co-authored-by: Erovia <Erovia@users.noreply.github.com> * more uniform date handling * make flake8 happy * Update lib/python/qmk/decorators.py Co-authored-by: Erovia <Erovia@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com> 2020-10-26 05:48:44 +08:00			`api_data/v1`
add version.h to gitignore (#16222) 2022-02-05 11:23:27 +08:00			`quantum/version.h`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`*.bin`
			`*.eep`
			`*.hex`
			`*.qmk`
			`*.uf2`

Reject info.json at keymap level (#20408) 2023-04-11 09:43:45 +08:00			`# DD config at wrong location`
			`/keyboards/*/keymaps//info.json`
Enable 'keyboard.json' as a build target (#22891) 2024-03-10 13:20:25 +08:00			`/keyboards/*/keymaps//keyboard.json`
Reject info.json at keymap level (#20408) 2023-04-11 09:43:45 +08:00
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Old-style QMK Makefiles`
Ignore kbfirmware exports (#17687) 2022-07-15 10:57:34 +08:00			`/keyboards/**/Makefile`

			`# kbfirmware....`
			`/keyboards/**/kb.h`
			`/keyboards/**/kb.c`
Added eclipse settings files to .gitignore 2016-02-22 02:23:28 +08:00
Adding clueboard/cluepad support to qmk 2016-03-28 07:17:40 +08:00			`# Eclipse/PyCharm/Other IDE Settings`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`*.iml`
			`.browse.VC.db*`
Added eclipse settings files to .gitignore 2016-02-22 02:23:28 +08:00			`.cproject`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`.idea`
			`.idea/`
Added eclipse settings files to .gitignore 2016-02-22 02:23:28 +08:00			`.project`
ignore dfu-programme.exe in commits 2016-02-27 03:03:19 +08:00			`.settings/`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00
			`# ?`
			`.dep`
			`.history/`
			`build/`
			`cmake-build-debug`
			`CMakeLists.txt`
Remove some .gitignore files (#18689) 2022-10-13 05:36:51 +08:00			`*.pdf`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00
Exclude .build and .hex from Visual Studio code 2017-06-25 19:17:51 +08:00			`# Let these ones be user specific, since we have so many different configurations`
[Config] Add VSCode workspace files to .gitignore (#12469) 2021-04-26 04:46:28 +08:00			`*.code-workspace`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`.stfolder`
			`.tags`
333fred layout update (#1971) * Set up tap dance for layers on the lower button. * Refactored code to share in the users directory between my two keyboard layouts. * Small keyboard layout change. * Updated documentation on oneshot usage in macros/tap dance. 2017-11-07 01:09:01 +08:00			`.vscode/c_cpp_properties.json`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`.vscode/ipch/`
			`.vscode/last.sql`
Exclude .build and .hex from Visual Studio code 2017-06-25 19:17:51 +08:00			`.vscode/launch.json`
			`.vscode/tasks.json`
Instruct VSCode to indent using spaces, also ignore two temp files created by VSCode. 2017-09-21 01:38:27 +08:00			`.vscode/temp.sql`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`tags`
remove most .pngs 2017-06-12 03:36:28 +08:00
Add Djinn. (#17382) * Add Djinn. * Review comments. * Further cleanup. 2022-06-20 12:20:56 +08:00			`# Ignore image/font files`
Update .gitignore (#19132) 2022-11-22 10:32:36 +08:00			`*.bmp`
			`*.wbmp`
Modified gitignore file to allow the left and right hand eeprom files for the MiniDox to be added. They need to be there for proper flashing of the board. They do not change between builds, so no need to re-build them. 2017-08-07 19:55:33 +08:00			`*.gif`
[Docs] Update hand wire guide (#7044) * Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading 2019-10-26 02:48:59 +08:00			`*.jpg`
Update .gitignore (#19132) 2022-11-22 10:32:36 +08:00			`*.jpeg`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`*.png`
Update .gitignore (#19132) 2022-11-22 10:32:36 +08:00			`*.apng`
			`*.mng`
			`*.svg`
			`*.webp`
			`*.webm`
			`*.avi`
			`*.mp4`
			`*.mpeg`
Add Djinn. (#17382) * Add Djinn. * Review comments. * Further cleanup. 2022-06-20 12:20:56 +08:00			`*.ttf`
			`*.otf`
Modified gitignore file to allow the left and right hand eeprom files for the MiniDox to be added. They need to be there for proper flashing of the board. They do not change between builds, so no need to re-build them. 2017-08-07 19:55:33 +08:00
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Things Travis sees`
Generate API docs from source code comments (#2491) * Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly 2018-03-22 14:50:38 +08:00			`/.vs`
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`id_rsa_*`
			`secrets.tar`
QMK CLI and JSON keymap support (#6176) * Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function 2019-07-16 03:14:27 +08:00
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Python things`
QMK CLI and JSON keymap support (#6176) * Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function 2019-07-16 03:14:27 +08:00			`__pycache__`
Add python-version to gitignore (#12678) 2021-04-27 03:18:17 +08:00			`.python-version`
chore: ignore virtual environment directory (#20905) 2023-09-03 09:24:57 +08:00			`.venv`
2020 February 29 Breaking Changes Update (#8064) 2020-03-01 04:00:00 +08:00
Cleanup gitignore (#13390) 2021-07-02 14:08:34 +08:00			`# Prerequisites for updating ChibiOS`
2020 February 29 Breaking Changes Update (#8064) 2020-03-01 04:00:00 +08:00			`/util/fmpp*`
Allow for user song list (#9281) 2020-07-16 14:45:50 +08:00
			`# Allow to exist but don't include it in the repo`
			`user_song_list.h`
New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * remove MAKEFLAGS from environment for better control over process management * Update .gitignore Co-authored-by: Michael Forster <forster@google.com> * add a usage line to docs * doc change as suggested Co-authored-by: Nick Brassel <nick@tzarc.org> * rename command * remove debug print statements * generate-compilation-database: fix arg handling * generate-comilation-db: improve error handling * use cli.run() instead of Popen() Co-authored-by: Xton <cdewan@apple.com> Co-authored-by: Christon DeWan <cmdpix@mac.com> Co-authored-by: Michael Forster <forster@google.com> Co-authored-by: Nick Brassel <nick@tzarc.org> 2021-09-16 12:59:57 +08:00
			`# clangd`
			`compile_commands.json`
			`.clangd/`
			`.cache/`
Ignore VIA(L) json files (#16845) 2022-04-14 13:42:24 +08:00
Flag vial keymaps in 'qmk lint' (#22227) 2023-10-08 19:45:13 +08:00			`# VIA(L) files that don't belong in QMK repo`
Ignore VIA(L) json files (#16845) 2022-04-14 13:42:24 +08:00			`via*.json`
Add via keymaps to gitignore (#24329) 2024-08-26 11:33:40 +08:00			`/keyboards/*/keymaps/via/`
Flag vial keymaps in 'qmk lint' (#22227) 2023-10-08 19:45:13 +08:00			`/keyboards/*/keymaps/vial/`