Skip to content

Latest commit

 

History

History
126 lines (83 loc) · 3.76 KB

Windows.md

File metadata and controls

126 lines (83 loc) · 3.76 KB
Raw

Building & Running on Windows

These instructions cover building 32blit on Windows (without WSL).

Prerequisites

  • Windows Terminal - grab it from the Windows Store
  • Git for Windows
  • Python - eg: "python-3.9.6-amd64.exe"
  • The GNU Arm Embedded Toolchain (For 32blit device builds, use the 9-2020-q2-update version). Make sure to select the "Add path to environment variable" at the end of the setup.
  • At least the Visual Studio build tools (For local builds, select "Desktop development with C++"). This includes CMake and NMake.

If you have Visual Studio installed you can Modify the installation and select "MSVC vXXX - VS 2022 C++ x64/x86 build tools (Latest)" and "C++ CMake tools for Windows"

Setting Up

Open "Developer Command Prompt for VS 2022." This is where you'll build the 32blit SDK and flash .blit files to your device.

Install the 32blit tools:

py -m pip install 32blit

This may result in a waning similar to:

WARNING: The script 32blit.exe is installed in 'C:\Users\[Name]\AppData\Local\Programs\Python\Python39\Scripts' which is not on PATH.

You will either need to add that to your PATH, or run the tools as py -m ttblit ... instead of 32blit ....

You should now be able to run 32blit.exe, you can test your connection to your 32blit with:

32blit flash list

Building & Running

First you need something to build. The 32blit-examples repository includes a series of demos showcasing various 32blit SDK features. These instructions will assume you're building those and have cloned or extracted that repository alongside 32blit-sdk:

git clone https://github.com/32blit/32blit-examples

Your directory tree should look something like:

  • root_dir
    • 32blit-sdk
    • 32blit-examples

To build using Visual Studio see here. The rest of these instructions cover command-line builds.

On 32Blit

If you want to run code on 32Blit, you should now refer to Building & Running On 32Blit. On Windows you will need to add -G"NMake Makefiles" to your cmake commands, for example:

cd 32blit-examples
mkdir build.stm32
cd build.stm32
cmake -G"NMake Makefiles" -DCMAKE_TOOLCHAIN_FILE=../32blit.toolchain ..

Now to build an example, type:

cmake --build . --target raycaster

This will produce examples/raycaster/raycaster.blit.

You can build & flash to your 32blit with one command by adding ".flash" to the end of any target, for example:

cmake --build . --target raycaster.flash

Locally (Windows .exe)

Create a build directory and configure the examples. The 32blit-sdk should be automatically detected:

cd 32blit-examples
mkdir build
cd build
cmake -G"NMake Makefiles" ..

Now to make any example, type:

cmake --build . --target raycaster

This will produce examples\raycaster\raycaster.exe which you should run with:

examples\raycaster\raycaster

List Targets

For an exhaustive list of all the examples you can build, type:

cmake --build . --target help

Build Everything

Whether you're building locally or for device you can build the SDK and all examples by typing:

cmake --build .

When the build completes you should be able to run/install any example.