Harry Herring
parent
7a359a55d0
commit
d788236304
1 changed files with 206 additions and 206 deletions
412
docs/static/setup.ps1
vendored
412
docs/static/setup.ps1
vendored
|
|
@ -1,206 +1,206 @@
|
||||||
# Copyright (c) 2020 The ZMK Contributors
|
# Copyright (c) 2020 The ZMK Contributors
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
$ErrorActionPreference = "Stop"
|
$ErrorActionPreference = "Stop"
|
||||||
|
|
||||||
function Get-Choice-From-Options {
|
function Get-Choice-From-Options {
|
||||||
param(
|
param(
|
||||||
[String[]] $Options,
|
[String[]] $Options,
|
||||||
[String] $Prompt
|
[String] $Prompt
|
||||||
)
|
)
|
||||||
|
|
||||||
while ($true) {
|
while ($true) {
|
||||||
for ($i = 0; $i -lt $Options.length; $i++) {
|
for ($i = 0; $i -lt $Options.length; $i++) {
|
||||||
Write-Host "$($i + 1)) $($Options[$i])"
|
Write-Host "$($i + 1)) $($Options[$i])"
|
||||||
}
|
}
|
||||||
|
|
||||||
Write-Host "$($Options.length + 1)) Quit"
|
Write-Host "$($Options.length + 1)) Quit"
|
||||||
$selection = (Read-Host $Prompt) -as [int]
|
$selection = Read-Host $Prompt
|
||||||
|
|
||||||
if ($selection -eq $Options.length + 1) {
|
if ($selection -eq $Options.length + 1) {
|
||||||
Write-Host "Goodbye!"
|
Write-Host "Goodbye!"
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
elseif ($selection -le $Options.length -and $selection -gt 0) {
|
elseif ($selection -le $Options.length) {
|
||||||
$choice = $($selection - 1)
|
$choice = $($selection - 1)
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
Write-Host "Invalid Option. Try another one."
|
Write-Host "Invalid Option. Try another one."
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return $choice
|
return $choice
|
||||||
}
|
}
|
||||||
|
|
||||||
function Test-Git-Config {
|
function Test-Git-Config {
|
||||||
param(
|
param(
|
||||||
[String] $Option,
|
[String] $Option,
|
||||||
[String] $ErrMsg
|
[String] $ErrMsg
|
||||||
)
|
)
|
||||||
|
|
||||||
git config $Option | Out-Null
|
git config $Option | Out-Null
|
||||||
|
|
||||||
if ($lastExitCode -ne 0) {
|
if ($lastExitCode -ne 0) {
|
||||||
Write-Host $ErrMsg
|
Write-Host $ErrMsg
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
git | Out-Null
|
git | Out-Null
|
||||||
}
|
}
|
||||||
catch [System.Management.Automation.CommandNotFoundException] {
|
catch [System.Management.Automation.CommandNotFoundException] {
|
||||||
Write-Host "Git is not installed, and is required for this script!"
|
Write-Host "Git is not installed, and is required for this script!"
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
Test-Git-Config -Option "user.name" -ErrMsg "Git username not set!`nRun: git config --global user.name 'My Name'"
|
Test-Git-Config -Option "user.name" -ErrMsg "Git username not set!`nRun: git config --global user.name 'My Name'"
|
||||||
Test-Git-Config -Option "user.email" -ErrMsg "Git email not set!`nRun: git config --global user.email 'example@myemail.com'"
|
Test-Git-Config -Option "user.email" -ErrMsg "Git email not set!`nRun: git config --global user.email 'example@myemail.com'"
|
||||||
|
|
||||||
$permission = (Get-Acl $pwd).Access |
|
$permission = (Get-Acl $pwd).Access |
|
||||||
?{$_.IdentityReference -match $env:UserName `
|
?{$_.IdentityReference -match $env:UserName `
|
||||||
-and $_.FileSystemRights -match "FullControl" `
|
-and $_.FileSystemRights -match "FullControl" `
|
||||||
-or $_.FileSystemRights -match "Write" } |
|
-or $_.FileSystemRights -match "Write" } |
|
||||||
|
|
||||||
Select IdentityReference,FileSystemRights
|
Select IdentityReference,FileSystemRights
|
||||||
|
|
||||||
If (-Not $permission){
|
If (-Not $permission){
|
||||||
Write-Host "Sorry, you do not have write permissions in this directory."
|
Write-Host "Sorry, you do not have write permissions in this directory."
|
||||||
Write-Host "Please try running this script again from a directory that you do have write permissions for."
|
Write-Host "Please try running this script again from a directory that you do have write permissions for."
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
$repo_path = "https://github.com/zmkfirmware/zmk-config-split-template.git"
|
$repo_path = "https://github.com/zmkfirmware/zmk-config-split-template.git"
|
||||||
|
|
||||||
$title = "ZMK Config Setup:"
|
$title = "ZMK Config Setup:"
|
||||||
$prompt = "Pick an MCU board"
|
$prompt = "Pick an MCU board"
|
||||||
$options = "nice!nano", "QMK Proton-C", "BlueMicro840 (v1)", "makerdiary nRF52840 M.2"
|
$options = "nice!nano", "QMK Proton-C", "BlueMicro840 (v1)", "makerdiary nRF52840 M.2"
|
||||||
$boards = "nice_nano", "proton_c", "bluemicro840_v1", "nrf52840_m2"
|
$boards = "nice_nano", "proton_c", "bluemicro840_v1", "nrf52840_m2"
|
||||||
|
|
||||||
Write-Host "$title"
|
Write-Host "$title"
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
Write-Host "MCU Board Selection:"
|
Write-Host "MCU Board Selection:"
|
||||||
|
|
||||||
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
||||||
$board = $($boards[$choice])
|
$board = $($boards[$choice])
|
||||||
|
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
Write-Host "Keyboard Shield Selection:"
|
Write-Host "Keyboard Shield Selection:"
|
||||||
$prompt = "Pick a keyboard"
|
$prompt = "Pick a keyboard"
|
||||||
|
|
||||||
# TODO: Add support for "Other" and linking to docs on adding custom shields in user config repos.
|
# TODO: Add support for "Other" and linking to docs on adding custom shields in user config repos.
|
||||||
$options = "Kyria", "Lily58", "Corne", "Splitreus62", "Sofle", "Iris", "Reviung41", "RoMac", "RoMac+", "makerdiary M60", "Microdox", "TG4X", "QAZ", "NIBBLE", "CRBN", "Jorne", "Jian"
|
$options = "Kyria", "Lily58", "Corne", "Splitreus62", "Sofle", "Iris", "Reviung41", "RoMac", "RoMac+", "makerdiary M60", "Microdox", "TG4X", "QAZ", "NIBBLE", "CRBN", "Jorne", "Jian"
|
||||||
$names = "kyria", "lily58", "corne", "splitreus62", "sofle", "iris", "reviung41", "romac", "romac_plus", "m60", "microdox", "tg4x", "qaz", "nibble", "crbn", "jorne", "jian"
|
$names = "kyria", "lily58", "corne", "splitreus62", "sofle", "iris", "reviung41", "romac", "romac_plus", "m60", "microdox", "tg4x", "qaz", "nibble", "crbn", "jorne", "jian"
|
||||||
$splits = "y", "y", "y", "y", "y", "y", "n", "n", "n", "n", "y", "n", "n", "n", "n", "y", "y"
|
$splits = "y", "y", "y", "y", "y", "y", "n", "n", "n", "n", "y", "n", "n", "n", "n", "y", "y"
|
||||||
|
|
||||||
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
|
||||||
$shield_title = $($options[$choice])
|
$shield_title = $($options[$choice])
|
||||||
$shield = $($names[$choice])
|
$shield = $($names[$choice])
|
||||||
$split = $($splits[$choice])
|
$split = $($splits[$choice])
|
||||||
|
|
||||||
if ($split -eq "n") {
|
if ($split -eq "n") {
|
||||||
$repo_path = "https://github.com/zmkfirmware/zmk-config-template.git"
|
$repo_path = "https://github.com/zmkfirmware/zmk-config-template.git"
|
||||||
}
|
}
|
||||||
|
|
||||||
$copy_keymap = Read-Host "Copy in the stock keymap for customisation? [Yn]"
|
$copy_keymap = Read-Host "Copy in the stock keymap for customisation? [Yn]"
|
||||||
|
|
||||||
if ($copy_keymap -eq "" -or $copy_keymap -eq "Y" -or $copy_keymap -eq "y") {
|
if ($copy_keymap -eq "" -or $copy_keymap -eq "Y" -or $copy_keymap -eq "y") {
|
||||||
$copy_keymap = "yes"
|
$copy_keymap = "yes"
|
||||||
}
|
}
|
||||||
|
|
||||||
$github_user = Read-Host "GitHub Username (leave empty to skip GitHub repo creation)"
|
$github_user = Read-Host "GitHub Username (leave empty to skip GitHub repo creation)"
|
||||||
|
|
||||||
if ($github_user -ne "") {
|
if ($github_user -ne "") {
|
||||||
$repo_name = Read-Host "GitHub Repo Name [zmk-config]"
|
$repo_name = Read-Host "GitHub Repo Name [zmk-config]"
|
||||||
|
|
||||||
if ($repo_name -eq "") {
|
if ($repo_name -eq "") {
|
||||||
$repo_name = "zmk-config"
|
$repo_name = "zmk-config"
|
||||||
}
|
}
|
||||||
|
|
||||||
$github_repo = Read-Host "GitHub Repo [https://github.com/$github_user/$repo_name.git]"
|
$github_repo = Read-Host "GitHub Repo [https://github.com/$github_user/$repo_name.git]"
|
||||||
|
|
||||||
if ($github_repo -eq "") {
|
if ($github_repo -eq "") {
|
||||||
$github_repo = "https://github.com/$github_user/$repo_name.git"
|
$github_repo = "https://github.com/$github_user/$repo_name.git"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
$repo_name = "zmk-config"
|
$repo_name = "zmk-config"
|
||||||
$github_repo = ""
|
$github_repo = ""
|
||||||
}
|
}
|
||||||
|
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
Write-Host "Preparing a user config for:"
|
Write-Host "Preparing a user config for:"
|
||||||
Write-Host "* MCU Board: ${board}"
|
Write-Host "* MCU Board: ${board}"
|
||||||
Write-Host "* Shield: ${shield}"
|
Write-Host "* Shield: ${shield}"
|
||||||
|
|
||||||
if ($copy_keymap -eq "yes") {
|
if ($copy_keymap -eq "yes") {
|
||||||
Write-Host "* Copy Keymap?: Yes"
|
Write-Host "* Copy Keymap?: Yes"
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
Write-Host "* Copy Keymap?: No"
|
Write-Host "* Copy Keymap?: No"
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($github_repo -ne "") {
|
if ($github_repo -ne "") {
|
||||||
Write-Host "* GitHub Repo to Push (please create this in GH first!): $github_repo"
|
Write-Host "* GitHub Repo to Push (please create this in GH first!): $github_repo"
|
||||||
}
|
}
|
||||||
|
|
||||||
Write-Host ""
|
Write-Host ""
|
||||||
$do_it = Read-Host "Continue? [Yn]"
|
$do_it = Read-Host "Continue? [Yn]"
|
||||||
|
|
||||||
if ($do_it -ne "" -and $do_it -ne "Y" -and $do_it -ne "y") {
|
if ($do_it -ne "" -and $do_it -ne "Y" -and $do_it -ne "y") {
|
||||||
Write-Host "Aborting..."
|
Write-Host "Aborting..."
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
git clone --single-branch "$repo_path" "$repo_name"
|
git clone --single-branch "$repo_path" "$repo_name"
|
||||||
Set-Location "$repo_name"
|
Set-Location "$repo_name"
|
||||||
|
|
||||||
Push-Location config
|
Push-Location config
|
||||||
|
|
||||||
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.conf" -OutFile "${shield}.conf"
|
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.conf" -OutFile "${shield}.conf"
|
||||||
|
|
||||||
if ($copy_keymap -eq "yes") {
|
if ($copy_keymap -eq "yes") {
|
||||||
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.keymap" -OutFile "${shield}.keymap"
|
Invoke-RestMethod -Uri "https://raw.githubusercontent.com/zmkfirmware/zmk/main/app/boards/shields/${shield}/${shield}.keymap" -OutFile "${shield}.keymap"
|
||||||
}
|
}
|
||||||
|
|
||||||
Pop-Location
|
Pop-Location
|
||||||
|
|
||||||
$build_file = (Get-Content .github/workflows/build.yml).replace("BOARD_NAME", $board)
|
$build_file = (Get-Content .github/workflows/build.yml).replace("BOARD_NAME", $board)
|
||||||
$build_file = $build_file.replace("SHIELD_NAME", $shield)
|
$build_file = $build_file.replace("SHIELD_NAME", $shield)
|
||||||
$build_file = $build_file.replace("KEYBOARD_TITLE", $shield_title)
|
$build_file = $build_file.replace("KEYBOARD_TITLE", $shield_title)
|
||||||
|
|
||||||
if ($board -eq "proton_c") {
|
if ($board -eq "proton_c") {
|
||||||
$build_file = $build_file.replace("uf2", "hex")
|
$build_file = $build_file.replace("uf2", "hex")
|
||||||
}
|
}
|
||||||
|
|
||||||
Set-Content -Path .github/workflows/build.yml -Value $build_file
|
Set-Content -Path .github/workflows/build.yml -Value $build_file
|
||||||
|
|
||||||
Remove-Item -Recurse -Force .git
|
Remove-Item -Recurse -Force .git
|
||||||
git init .
|
git init .
|
||||||
git add .
|
git add .
|
||||||
git commit -m "Initial User Config."
|
git commit -m "Initial User Config."
|
||||||
|
|
||||||
if ($github_repo -ne "") {
|
if ($github_repo -ne "") {
|
||||||
git remote add origin "$github_repo"
|
git remote add origin "$github_repo"
|
||||||
|
|
||||||
git push --set-upstream origin $(git symbolic-ref --short HEAD)
|
git push --set-upstream origin $(git symbolic-ref --short HEAD)
|
||||||
|
|
||||||
# If push failed, assume that the origin was incorrect and give instructions on fixing.
|
# If push failed, assume that the origin was incorrect and give instructions on fixing.
|
||||||
if ($lastExitCode -ne 0) {
|
if ($lastExitCode -ne 0) {
|
||||||
Write-Host "Remote repository $github_repo not found..."
|
Write-Host "Remote repository $github_repo not found..."
|
||||||
Write-Host "Check GitHub URL, and try adding again."
|
Write-Host "Check GitHub URL, and try adding again."
|
||||||
Write-Host "Run the following: "
|
Write-Host "Run the following: "
|
||||||
Write-Host " git remote rm origin"
|
Write-Host " git remote rm origin"
|
||||||
Write-Host " git remote add origin FIXED_URL"
|
Write-Host " git remote add origin FIXED_URL"
|
||||||
Write-Host " git push --set-upstream origin $(git symbolic-ref --short HEAD)"
|
Write-Host " git push --set-upstream origin $(git symbolic-ref --short HEAD)"
|
||||||
Write-Host "Once pushed, your firmware should be availalbe from GitHub Actions at: $actions"
|
Write-Host "Once pushed, your firmware should be availalbe from GitHub Actions at: $actions"
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($github_repo -imatch "https") {
|
if ($github_repo -imatch "https") {
|
||||||
$actions = "$($github_repo.substring(0, $github_repo.length - 4))/actions"
|
$actions = "$($github_repo.substring(0, $github_repo.length - 4))/actions"
|
||||||
Write-Host "Your firmware should be availalbe from GitHub Actions shortly: $actions"
|
Write-Host "Your firmware should be availalbe from GitHub Actions shortly: $actions"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue