Move Alice to TGR Directory (#6502)
* git mv alice into the tgr directory * update readme with new build instructions
This commit is contained in:
		
				
					committed by
					
						
						Drashna Jaelre
					
				
			
			
				
	
			
			
			
						parent
						
							8479dd65d4
						
					
				
				
					commit
					2c0c25d014
				
			@@ -1,60 +0,0 @@
 | 
			
		||||
# TGR Alice
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
An ergonomic 60% keyboard.
 | 
			
		||||
 | 
			
		||||
Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)  
 | 
			
		||||
Hardware Supported: TGR Alice  
 | 
			
		||||
Hardware Availability: Group buy finished  
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make alice:default
 | 
			
		||||
 | 
			
		||||
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
ps2avrGB keyboard firmware
 | 
			
		||||
==========================
 | 
			
		||||
 | 
			
		||||
This keyboard uses the port of the QMK firmware for boards that are based on the
 | 
			
		||||
ps2avrGB firmware.
 | 
			
		||||
 | 
			
		||||
Note that this is a complete replacement for the firmware, so you won't be
 | 
			
		||||
using Bootmapper Client to change any keyboard settings, since not all the
 | 
			
		||||
USB report options are supported.
 | 
			
		||||
 | 
			
		||||
## Installing
 | 
			
		||||
 | 
			
		||||
First, install the requirements. These commands are for OSX, but all you
 | 
			
		||||
need is the AVR toolchain and `bootloadHID` for flashing:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
$ brew cask install crosspack-avr
 | 
			
		||||
$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 | 
			
		||||
$ pip install pyusb
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Then, with the keyboard plugged in, simply run this command from the
 | 
			
		||||
`qmk_firmware` directory:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
$ make alice
 | 
			
		||||
$ bootloadHID -r alice_default.hex
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Setting the board to bootloader mode
 | 
			
		||||
 | 
			
		||||
Hold the ESC key (the one before the 1! key, in case you remaped it).
 | 
			
		||||
 | 
			
		||||
## Troubleshooting
 | 
			
		||||
 | 
			
		||||
From my experience, it's really hard to brick these boards. But these
 | 
			
		||||
tricks have been useful when it got stuck in a weird scenario.
 | 
			
		||||
 | 
			
		||||
1. Try plugging the board in while holding the bootloader key. This will force
 | 
			
		||||
   it to boot only the bootloader without loading the firmware. Once this is
 | 
			
		||||
   done, just reflash the board with the original firmware.
 | 
			
		||||
2. Sometimes USB hubs can act weird, so try connecting the board directly
 | 
			
		||||
   to your computer or plugging/unplugging the USB hub.
 | 
			
		||||
							
								
								
									
										48
									
								
								keyboards/tgr/alice/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								keyboards/tgr/alice/readme.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,48 @@
 | 
			
		||||
# Alice
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
An ergonomic 60% keyboard.
 | 
			
		||||
 | 
			
		||||
Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)  
 | 
			
		||||
Hardware Supported: TGR Alice  
 | 
			
		||||
Hardware Availability: Group buy finished  
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make tgr/alice:default
 | 
			
		||||
 | 
			
		||||
Flashing
 | 
			
		||||
 | 
			
		||||
ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
 | 
			
		||||
 | 
			
		||||
**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
 | 
			
		||||
 | 
			
		||||
Windows: 
 | 
			
		||||
1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
 | 
			
		||||
2. Place your keyboard into reset. 
 | 
			
		||||
3. Press the `Find Device` button and ensure that your keyboard is found.
 | 
			
		||||
4. Press the `Open .hex File` button and locate the `.hex` file you created.
 | 
			
		||||
5. Press the `Flash Device` button and wait for the process to complete. 
 | 
			
		||||
 | 
			
		||||
macOS:
 | 
			
		||||
1. Install homebrew by typing the following:   
 | 
			
		||||
    ```
 | 
			
		||||
    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 | 
			
		||||
    ```
 | 
			
		||||
2. Install `crosspack-avr`.  
 | 
			
		||||
    ```
 | 
			
		||||
    brew cask install crosspack-avr
 | 
			
		||||
    ```
 | 
			
		||||
3. Install the following packages:
 | 
			
		||||
    ```
 | 
			
		||||
    brew install python3
 | 
			
		||||
    pip3 install pyusb
 | 
			
		||||
    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 | 
			
		||||
    ```
 | 
			
		||||
 | 
			
		||||
4. Place your keyboard into reset. 
 | 
			
		||||
5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
 | 
			
		||||
		Reference in New Issue
	
	Block a user