annotate Keyboards/ergodox.bash @ 452:31daf3b37f7a

Modify the ergodox buildscript for my configuration
author Louis Opter <kalessin@kalessin.fr>
date Mon, 27 Jun 2016 21:21:53 -0700
parents 99f93dec8fea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
401
99f93dec8fea Start removing select Linux-isms
Dan McGregor <dan.mcgregor@usask.ca>
parents: 373
diff changeset
1 #!/usr/bin/env bash
365
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
2 # This is a build script template
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
3 # These build scripts are just a convenience for configuring your keyboard (less daunting than CMake)
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
4 # Jacob Alexander 2015
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
5
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
6
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
7
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
8 #################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
9 # Configuration #
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
10 #################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
11
373
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
12 ######## Left Side ########
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
13
365
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
14 # Feel free to change the variables in this section to configure your keyboard
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
15
373
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
16 BuildPath="ICED-L"
365
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
17
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
18 ## KLL Configuration ##
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
19
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
20 # Generally shouldn't be changed, this will affect every layer
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
21 BaseMap="defaultMap leftHand slave1 rightHand"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
22
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
23 # This is the default layer of the keyboard
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
24 # NOTE: To combine kll files into a single layout, separate them by spaces
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
25 # e.g. DefaultMap="mylayout mylayoutmod"
452
31daf3b37f7a Modify the ergodox buildscript for my configuration
Louis Opter <kalessin@kalessin.fr>
parents: 401
diff changeset
26 DefaultMap="louis_lmain lcdFuncMap"
365
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
27
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
28 # This is where you set the additional layers
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
29 # NOTE: Indexing starts at 1
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
30 # NOTE: Each new layer is another array entry
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
31 # e.g. PartialMaps[1]="layer1 layer1mod"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
32 # PartialMaps[2]="layer2"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
33 # PartialMaps[3]="layer3"
452
31daf3b37f7a Modify the ergodox buildscript for my configuration
Louis Opter <kalessin@kalessin.fr>
parents: 401
diff changeset
34 PartialMaps[1]="lcdFuncMap louis_l1"
31daf3b37f7a Modify the ergodox buildscript for my configuration
Louis Opter <kalessin@kalessin.fr>
parents: 401
diff changeset
35 PartialMaps[7]="lcdFuncMap louis_l7"
365
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
36
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
37
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
38
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
39 ##########################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
40 # Advanced Configuration #
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
41 ##########################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
42
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
43 # Don't change the variables in this section unless you know what you're doing
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
44 # These are useful for completely custom keyboards
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
45 # NOTE: Changing any of these variables will require a force build to compile correctly
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
46
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
47 # Keyboard Module Configuration
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
48 ScanModule="MDErgo1"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
49 MacroModule="PartialMap"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
50 OutputModule="pjrcUSB"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
51 DebugModule="full"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
52
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
53 # Microcontroller
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
54 Chip="mk20dx256vlh7"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
55
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
56 # Compiler Selection
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
57 Compiler="gcc"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
58
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
59
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
60
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
61 ########################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
62 # Bash Library Include #
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
63 ########################
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
64
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
65 # Shouldn't need to touch this section
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
66
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
67 # Check if the library can be found
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
68 if [ ! -f cmake.bash ]; then
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
69 echo "ERROR: Cannot find 'cmake.bash'"
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
70 exit 1
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
71 fi
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
72
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
73 # Load the library
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
74 source cmake.bash
dbe0dbd7e2dd Updating convenience scripts
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
75
373
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
76
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
77
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
78 #########################
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
79 # Re-run for right side #
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
80 #########################
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
81
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
82 ######## Right Side ########
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
83
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
84 # Feel free to change the variables in this section to configure your keyboard
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
85
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
86 BuildPath="ICED-R"
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
87
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
88 ## KLL Configuration ##
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
89
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
90 # Only changing the basemap (everything else is the same)
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
91 # Generally shouldn't be changed, this will affect every layer
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
92 BaseMap="defaultMap rightHand slave1 leftHand"
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
93
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
94 # Load the library (starts the build)
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
95 source cmake.bash
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
96
83cb0d4b57e3 Updating convenience build scripts to build Left and Right sides
Jacob Alexander <haata@kiibohd.com>
parents: 365
diff changeset
97