Add a newbie guide for people completely new to QMK (#2480)
This commit is contained in:
		
							parent
							
								
									12c8ee956d
								
							
						
					
					
						commit
						08e48eb6f5
					
				
					 11 changed files with 350 additions and 1 deletions
				
			
		
							
								
								
									
										17
									
								
								util/linux_install.sh
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								util/linux_install.sh
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,17 @@
 | 
			
		|||
#!/bin/sh
 | 
			
		||||
 | 
			
		||||
if grep ID /etc/os-release | grep -q rhel; then
 | 
			
		||||
	# RPM based OS
 | 
			
		||||
	sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc \
 | 
			
		||||
	    avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs \
 | 
			
		||||
	    arm-none-eabi-binutils-cs arm-none-eabi-newlib
 | 
			
		||||
elif grep ID /etc/os-release | grep -q debian; then
 | 
			
		||||
	sudo apt-get update
 | 
			
		||||
	sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc \
 | 
			
		||||
	    dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi \
 | 
			
		||||
	    libnewlib-arm-none-eabi
 | 
			
		||||
else
 | 
			
		||||
	echo "Sorry, we don't recognize your OS. Help us by contributing support!"
 | 
			
		||||
	echo
 | 
			
		||||
	echo "    https://docs.qmk.fm/contributing.html"
 | 
			
		||||
fi
 | 
			
		||||
							
								
								
									
										25
									
								
								util/macos_install.sh
									
										
									
									
									
										Executable file
									
								
							
							
						
						
									
										25
									
								
								util/macos_install.sh
									
										
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,25 @@
 | 
			
		|||
#!/bin/bash
 | 
			
		||||
 | 
			
		||||
if brew --version 2>&1 > /dev/null; then
 | 
			
		||||
	echo "Error! Homebrew not installed or broken!"
 | 
			
		||||
	echo -n "Would you like to install homebrew now? [y/n] "
 | 
			
		||||
	while read ANSWER; do
 | 
			
		||||
		case $ANSWER in
 | 
			
		||||
			y|Y)
 | 
			
		||||
				/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 | 
			
		||||
				break
 | 
			
		||||
			;;
 | 
			
		||||
			n|N)
 | 
			
		||||
				exit 1
 | 
			
		||||
			;;
 | 
			
		||||
			*)
 | 
			
		||||
				echo -n "Would you like to install homebrew now? [y/n] "
 | 
			
		||||
			;;
 | 
			
		||||
                esac
 | 
			
		||||
	done
 | 
			
		||||
fi
 | 
			
		||||
 | 
			
		||||
brew tap osx-cross/avr
 | 
			
		||||
brew tap PX4/homebrew-px4
 | 
			
		||||
brew update
 | 
			
		||||
brew install avr-gcc gcc-arm-none-eabi dfu-programmer avrdude
 | 
			
		||||
							
								
								
									
										16
									
								
								util/qmk_install.sh
									
										
									
									
									
										Executable file
									
								
							
							
						
						
									
										16
									
								
								util/qmk_install.sh
									
										
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,16 @@
 | 
			
		|||
#!/bin/sh
 | 
			
		||||
# Pick the correct install script based on the current OS
 | 
			
		||||
 | 
			
		||||
util_dir=$(dirname "$0")
 | 
			
		||||
 | 
			
		||||
case $(uname) in
 | 
			
		||||
	Darwin)
 | 
			
		||||
		exec "${util_dir}/macos_install.sh"
 | 
			
		||||
	;;
 | 
			
		||||
	Linux)
 | 
			
		||||
		exec "${util_dir}/linux_install.sh"
 | 
			
		||||
	;;
 | 
			
		||||
	MSYS_NT*)
 | 
			
		||||
		exec "${util_dir}/msys2_install.sh"
 | 
			
		||||
	;;
 | 
			
		||||
esac
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue