Installing Developer Tools: Common - johnttaylor/epc GitHub Wiki
The following tools are required for developing software for the GM6000, and they should be installed on both the development machine and the build server.
- Python
- Git
- Unix Tools for Windows
- Doxygen
- Graphviz
- Microsoft Help Compiler
- gcovr
- pexpect
- MinGW-w64 Compiler (aka GCC for Windows)
- Visual Studio
- 7-Zip
Note: Refer to the canonical tool version page for the required version of each tool being installed.
Installing Python
-
Download Python 3.11.
-
Run the python-3.11.•-amd64.exe install program.
-
Select Add python.exe to PATH.
-
Select Customize installation.
-
On the Optional Features page, select all available options and then select Next.
-
On the Advanced Options page, select Install Python 3.11 for all users.
This selects the first five advanced options. Downloading debugging symbols and binaries is optional.
-
Leave the default installation location.
-
Select Install.
-
Select Close.
-
Verify the installation by opening Command Prompt and entering
python --version
.
Note: In some cases, the installation program may not set the application association correctly, and Windows will open the Microsoft store when you try to run Python from a command prompt. Refer to this link for information on how to correct the application association.
Installing Git
Here are the Developer Git Install instructions.
Installing Unix tools
For Windows host, the basic Unix tools (e.g. ls
, rm
, grep
, etc.) need to be installed. These tools are installed as part of the Windows GIT Client software. If you followed the GIT install instructions no additional action is needed. If not, you will need to make sure that Unix tools installed on your Windows box have been added to the system environment variables Path.
Installing Doxygen
- Go to the Doxygen > Downloads page and download the latest binary distribution for Windows. Later versions, like
doxygen-1.9.•-setup.exe
support 64-bit Windows distributions. - Run the installer, and select Yes to allow the installation program to make changes to your machine.
- Accept the license agreement and select Next.
- Accept the default install options by selecting Next.
- Select Install.
- Select Next and then select Finish.
- From a command prompt enter
doxygen -v
to verify that Doxygen is installed.
If the installer did not do so, add the path to doxygen.exe
to the system environment variables Path (e.g., "C:\Program Files\doxygen\bin").
Note: You will need to install the following tools to use Doxygen:
- Graphviz — for drawing directed graphs
- Microsoft Help Compiler — for compiling all of the HTML pages into a single
.chm
Windows help file.
Installing Graphviz
- Download the latest 64-bit Graphviz installer.
- Run the installer and accept the default install options
Installing the Microsoft Help Compiler
- Download the Microsoft HTML Help Workshop compiler.
- Run the installer and accept the default options. You will see a message that you "already have a newer version of HTML Help". Ignore this message. This message refers to the run-time components for displaying HTML Help on Windows, and on current computers, the existing runtimes will always newer than those in the HTML Help Workshop package.
- From a command prompt enter
hhw
to verify that help compiler is installed.
If the installer did not do so, add the path to hhw.exe
to the system environment variables Path (e.g., "C:\Program Files (x86)\HTML Help Workshop").
Installing gcovr
gcovr
is a Python library for generating code coverage metrics.
- To install
gcovr
enter the following in a command prompt window:pip install gcovr
Installing pexepect
pexpect
is a Python library that is needed by the automated test tool ratt
.
- To install
pexpect
enter the following in a command prompt window:pip install pexpect
Installing MinGW-w64 Compiler (aka GCC for Windows)
To install the MinGW-w64 compiler, follow the Installing the MinGW Compiler instructions.
Installing Visual Studio.
-
Download and run the latest Visual Studio Community Installer.
-
Select Yes to allow the Visual Studio Installer to make changes to your machine.
-
Select Continue.
-
From the Workloads tab select the following:
-
.NET desktop development
-
Desktop developmment with C++
-
-
Select Install.
-
After the installation completes, click OK.
-
In a command prompt window, enter
dotnet --version
to verify the installation completed successfully.
Installing 7-Zip
7 Zip is used to package up build artifacts into ZIP files. While it is technically not required to be installed on the developer machine, it is still a very handy tool to have available.
- Download the latest 64-bit 7-Zip installer.
- Run the installer and accept the default options.
- Add the 7-Zip directory (e.g.
C:\Program Files\7-Zip
) to the Windows command path - In a command prompt window, enter
7z -h
to verify the installation completed successfully.