Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 3.15 KB

installation.md

File metadata and controls

104 lines (74 loc) · 3.15 KB
Raw

Installing GnwManager

GnWManager is easy to install, and it generally just installed like any python package. Like other python-based CLI tools, it's best to install with pipx. This tutorial breaks it up by operating system in case you are really starting from scratch.

Windows

Click to expand.

Installing Chocolately

Chocolately is a package manager for Windows. A package manager streamlines the installation and updating of software. Think of it like a CLI-based app store.

To install Chocolately, follow their install instructions.

To summarize their installation instructions, open PowerShell with "Run as administrator" and run the following command.

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

Installing python

If you don't have a modern (>=3.8) version of python installed, you can install it with Chocolately:

choco install python

Proceed to the common section for remaining installation instructions.

MacOS

Click to expand.

Installing Homebrew

Homebrew is a package manager for MacOS. A package manager streamlines the installation and updating of software. Think of it like a CLI-based app store.

To install Homebrew, follow their install instructions.

To summarize their installation instructions, run the following command in a terminal.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Installing python

If you don't have a modern (>=3.8) version of python installed, you can install it with brew:

brew install python

Proceed to the common section for remaining installation instructions.

Linux (Debian/Ubuntu)

Click to expand.

Installing python

If you don't have a modern (>=3.8) version of python installed, you can install it with apt-get:

sudo apt-get update
sudo apt-get install python

Proceed to the common section for remaining installation instructions.

Common

Installing pipx

Install pipx, following the instructions on its website.

Installing gnwmanager

GnWManager can now be installed with pipx:

pipx install gnwmanager

Installing third-party gnwmanager dependencies

GnWManager depends on OpenOCD to handle debugger-probe communications. GnWManager offers a crossplatform way of installing openocd:

gnwmanager install openocd

Updating

As of version v0.5.0, GnWManager provides the command gnwmanager upgrade to update itself.

Alternatively, update GnWManager as you would any python command line tool installed by pipx:

pipx upgrade gnwmanager