mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-22 08:27:56 +06:00
Code Issues Packages Projects Releases Wiki Activity

Streamline the macos install process

Browse Source
This commit is contained in:
skullY 2020-04-20 17:35:40 -07:00 committed by Zach White
parent ee2eb01653
commit fcf150bd82
4 changed files with 12 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/cli.md
View File

@ -13,18 +13,17 @@ QMK requires Python 3.6 or greater. We try to keep the number of requirements sm
If you have installed [Homebrew](https://brew.sh) you can tap and install QMK: If you have installed [Homebrew](https://brew.sh) you can tap and install QMK:
``` ```
brew tap qmk/qmk brew install qmk/qmk/qmk
brew install qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
``` ```
### Install Using easy_install or pip :id=install-using-easy_install-or-pip ### Install Using pip :id=install-using-easy_install-or-pip
If your system is not listed above you can install QMK manually. First ensure that you have python 3.6 (or later) installed and have installed pip. Then install QMK with this command: If your system is not listed above you can install QMK manually. First ensure that you have Python 3.6 (or later) installed and have installed pip. Then install QMK with this command:
``` ```
pip3 install qmk python3 -m pip install qmk
export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
``` ```

16
docs/faq_build.md
View File

@ -113,26 +113,16 @@ OPT_DEFS += -DBOOTLOADER_SIZE=2048
``` ```
## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` on MacOS ## `avr-gcc: internal compiler error: Abort trap: 6 (program cc1)` on MacOS
This is an issue with updating on brew, causing symlinks that avr-gcc depend on getting mangled. This is an issue with updating on brew, causing symlinks that avr-gcc depend on getting mangled.
The solution is to remove and reinstall all affected modules. The solution is to remove and reinstall all affected modules.
``` ```
brew rm avr-gcc brew rm avr-gcc avr-gcc@8 dfu-programmer dfu-util gcc-arm-none-eabi arm-gcc-bin@8 avrdude qmk
brew rm avr-gcc@8 brew install qmk/qmk/qmk
brew rm dfu-programmer
brew rm dfu-util
brew rm gcc-arm-none-eabi
brew rm arm-gcc-bin@8
brew rm avrdude
brew install avr-gcc@8
brew install dfu-programmer
brew install dfu-util
brew install arm-gcc-bin@8
brew install avrdude
brew link --force avr-gcc@8 brew link --force avr-gcc@8
brew link --force arm-gcc-bin@8 brew link --force arm-gcc-bin@8
``` ```
### `avr-gcc` and LUFA ### `avr-gcc` and LUFA

5
docs/newbs_getting_started.md
View File

@ -57,10 +57,9 @@ You may be asked to close and reopen the window. Do this and keep running the ab
You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh). You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh).
After Homebrew is installed run these commands: After Homebrew is installed run this command:
brew tap qmk/qmk brew install qmk/qmk/qmk
brew install qmk
### Linux ### Linux

7
util/macos_install.sh
View File

@ -21,11 +21,10 @@ if ! brew --version >/dev/null 2>&1; then
done done
fi fi
brew tap osx-cross/avr # All macOS dependencies are managed in the homebrew package:
brew tap osx-cross/arm # https://github.com/qmk/homebrew-qmk
brew update brew update
brew install avr-gcc@8 arm-gcc-bin@8 dfu-programmer avrdude clang-format dfu-util python3 brew install qmk/qmk/qmk
brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
brew link --force avr-gcc@8 brew link --force avr-gcc@8
brew link --force arm-gcc-bin@8 brew link --force arm-gcc-bin@8