MacOS Quick Start - Revision history

Fede.tft at 07:37, 15 May 2026

2026-05-15T07:37:29Z

← Older revision		Revision as of 07:37, 15 May 2026
Line 1:		Line 1:
	{{DISPLAYTITLE:macOS Quick Start}}		{{DISPLAYTITLE:macOS Quick Start}}
	This page explains how to install the precompiled Miosix Toolchain, ~~which since January 2023 is also available for macOS. The building instructions previously found on this page have been updated and moved to~~ [[Building GCC from sources]].		To be able to compile the Miosix kernel and your application, you need a patched version of the GCC compiler called [[Miosix Toolchain]]. This page explains how to install the precompiled Miosix Toolchain. If you prefer compiling GCC from sources, see [[Building GCC from sources]].

	Both macOS and Linux are POSIX-conformant Unix-like systems, therefore the steps required to get started with Miosix are very similar. This guide only covers the differences between the steps outlined in [[Linux Quick Start]] and the steps needed for macOS. Therefore reading the [[Linux Quick Start]] page is recommended ~~first~~.		Both macOS and Linux are POSIX-conformant Unix-like systems, therefore the steps required to get started with Miosix are very similar on both operating systems. This guide only covers the differences between the steps outlined in [[Linux Quick Start]] and the steps needed for macOS. Therefore reading the [[Linux Quick Start]] page first is recommended.

	== Before you begin ==		== Before you begin ==
Line 32:		Line 32:
	brew install stm32flash		brew install stm32flash
	</syntaxhighlight>		</syntaxhighlight>

	~~QSTLink2 is not supported on macOS.~~

	==== Homebrew, macOS, and filesystem permissions ====		==== Homebrew, macOS, and filesystem permissions ====
Line 59:		Line 57:
	== Install the Miosix Toolchain ==		== Install the Miosix Toolchain ==

	Download the latest version of the toolchain from the link provided in the [[Miosix Toolchain]] page. Make sure to install the macOS installable package, and not the Linux or Windows ones. Then you can install the toolchain by double-clicking the downloaded .pkg file.		Download the latest version of the toolchain from the link provided in the [[Miosix Toolchain]] page. Choose the appropriate version to your Mac architecture, as newer Macs use ARM processors, while older ones use Intel processors. We provide native builds of the Miosix toolchain for both architectures. Make sure to install the macOS installable package, and not the Linux or Windows ones. Then you can install the toolchain by double-clicking the downloaded .pkg file.

	If the installer does not open and the following dialog box shows up:		If the installer does not open and the following dialog box shows up:
Line 67:		Line 65:
	click with the right mouse button on the installer package (or click while pressing the ''control'' key on the keyboard) and select Open from the contextual menu. The dialog box will now let you open the package.		click with the right mouse button on the installer package (or click while pressing the ''control'' key on the keyboard) and select Open from the contextual menu. The dialog box will now let you open the package.

	Follow the steps presented by the assistant to install the Miosix toolchain on your system~~. If you are using an Apple Silicon (ARM) Mac, the installer will automatically propose to install Rosetta for you in case it is not already installed~~.		Follow the steps presented by the assistant to install the Miosix toolchain on your system.

	== Get, configure, and compile the Miosix kernel sources ==		== Get, configure, and compile the Miosix kernel sources ==

Daniele.cattaneo: MacOS is now called macOS.

2023-06-11T20:17:19Z

MacOS is now called macOS.

← Older revision		Revision as of 20:17, 11 June 2023
Line 1:		Line 1:
			{{DISPLAYTITLE:macOS Quick Start}}
	This page explains how to install the precompiled Miosix Toolchain, which since January 2023 is also available for macOS. The building instructions previously found on this page have been updated and moved to [[Building GCC from sources]].		This page explains how to install the precompiled Miosix Toolchain, which since January 2023 is also available for macOS. The building instructions previously found on this page have been updated and moved to [[Building GCC from sources]].

Daniele.cattaneo: Daniele.cattaneo moved page OS X Quick Start to MacOS Quick Start over redirect: OS X or MacOS X is now called just macOS (yes with a lowercase m).

2023-06-11T20:14:44Z

Daniele.cattaneo moved page OS X Quick Start to MacOS Quick Start over redirect: OS X or MacOS X is now called just macOS (yes with a lowercase m).

← Older revision	Revision as of 20:14, 11 June 2023
(No difference)

Daniele.cattaneo: Daniele.cattaneo moved page MacOS Quick Start to OS X Quick Start: For a while macOS was named OS X

2023-06-11T20:14:17Z

Daniele.cattaneo moved page MacOS Quick Start to OS X Quick Start: For a while macOS was named OS X

← Older revision	Revision as of 20:14, 11 June 2023
(No difference)

Daniele.cattaneo: More minor fixes

2023-06-11T16:24:15Z

More minor fixes

← Older revision		Revision as of 16:24, 11 June 2023
Line 68:		Line 68:
	Follow the steps presented by the assistant to install the Miosix toolchain on your system. If you are using an Apple Silicon (ARM) Mac, the installer will automatically propose to install Rosetta for you in case it is not already installed.		Follow the steps presented by the assistant to install the Miosix toolchain on your system. If you are using an Apple Silicon (ARM) Mac, the installer will automatically propose to install Rosetta for you in case it is not already installed.

	=== Get, configure, and compile the Miosix kernel sources ===		== Get, configure, and compile the Miosix kernel sources ==

	At this point you can start following the steps outlined in [[Linux Quick Start#Configuring and compiling the kernel]] without modifications.		At this point you can start following the steps outlined in [[Linux Quick Start#Configuring and compiling the kernel]] without modifications.

	Remember that there is no need to install ''git'' as it has been already installed as part of the Command Line Tools (if you have been following this guide to the letter).		Remember that there is no need to install ''git'' as it has been already installed as part of the Command Line Tools (if you have been following this guide to the letter).

Daniele.cattaneo: Minor fixes.

2023-06-11T16:21:58Z

Minor fixes.

← Older revision		Revision as of 16:21, 11 June 2023
Line 1:		Line 1:
	This page explains how to install the precompiled Miosix Toolchain, which since January 2023 is also available for macOS. The ~~previous~~ building instructions have been updated and moved to [[Building GCC from sources]].		This page explains how to install the precompiled Miosix Toolchain, which since January 2023 is also available for macOS. The building instructions previously found on this page have been updated and moved to [[Building GCC from sources]].

	Both macOS and Linux are POSIX-conformant Unix-like systems, therefore the steps required to get started with Miosix are very similar. This guide only covers the differences between the steps outlined in [[Linux Quick Start]] and the steps needed for macOS. Therefore reading the [[Linux Quick Start]] page is recommended first.		Both macOS and Linux are POSIX-conformant Unix-like systems, therefore the steps required to get started with Miosix are very similar. This guide only covers the differences between the steps outlined in [[Linux Quick Start]] and the steps needed for macOS. Therefore reading the [[Linux Quick Start]] page is recommended first.
Line 7:		Line 7:
	=== Installing the Command Line Tools ===		=== Installing the Command Line Tools ===

	macOS provides essentials tools for developing software ([https://clang.llvm.org clang]-based C and C++ compilers, [https://git-scm.com git], and more) in a separate package called the ''Command Line Tools for Xcode''. Despite the name, these tools do not require Xcode to be also installed, and since Xcode is a multi-gigabyte application which eats up quite the amount of disk space, you should '''not''' install Xcode unless you are sure you ~~really~~ need it for some other non-Miosix-related reason.		macOS provides essentials tools for developing software ([https://clang.llvm.org clang]-based C and C++ compilers, [https://git-scm.com git], and more) in a separate package called the ''Command Line Tools for Xcode''. Despite the name, these tools do not require Xcode to be also installed, and since Xcode is a multi-gigabyte application which eats up quite the amount of disk space, you should '''not''' install Xcode, unless you are sure you need it for some other non-Miosix-related reason.

	To install the Command Line Tools open Terminal.app and then run the following command:		To install the Command Line Tools open Terminal.app and then run the following command:
Line 19:		Line 19:
	=== Installing STM32-specific tools ===		=== Installing STM32-specific tools ===

	STM32 ~~Microcontrollers~~ are the most important target for Miosix, and programming them requires specialized tools which on Linux are often installed through a package manager.		STM32 microcontrollers are the most important target for Miosix, and programming them requires specialized tools which on Linux are often installed through a package manager.

	In contrast to Linux but similarly to Windows, macOS does not provide a system package manager. However, thanks to community efforts, there are two third-party package managers for macOS that provide a similar experience to Linux for easily installing tools and programs on the command line: [https://brew.sh Homebrew] and [https://www.macports.org MacPorts]. Both of them provide all packages you need to get started with development on STM32 MCUs.		In contrast to Linux but similarly to Windows, macOS does not provide a system package manager. However, thanks to community efforts, there are two third-party package managers for macOS that provide a similar experience to Linux for easily installing tools and programs on the command line: [https://brew.sh Homebrew] and [https://www.macports.org MacPorts]. Both of them provide all packages you need to get started with development on STM32 MCUs.
Line 51:		Line 51:

	macOS ships with <code>screen</code> built-in, there is no need to install it separately. If you find <code>screen</code> uncomfortable to use for accessing serial ports, we recommend you use [https://github.com/tio/tio tio], which can be installed via Homebrew with this command:		macOS ships with <code>screen</code> built-in, there is no need to install it separately. If you find <code>screen</code> uncomfortable to use for accessing serial ports, we recommend you use [https://github.com/tio/tio tio], which can be installed via Homebrew with this command:

			<syntaxhighlight>
			brew install tio
			</syntaxhighlight>

	== Install the Miosix Toolchain ==		== Install the Miosix Toolchain ==

Daniele.cattaneo: Rewrite the macOS quick start to take into account the fact that there is a toolchain binary available now.

2023-06-11T16:17:57Z

Rewrite the macOS quick start to take into account the fact that there is a toolchain binary available now.

Show changes

Fede.tft at 09:42, 10 January 2023

2023-01-10T09:42:00Z

← Older revision		Revision as of 09:42, 10 January 2023
Line 1:		Line 1:
	ATTENTION: This page is still a WIP. Usual disclaimers about not taking responsibility for your system disruption applies.		ATTENTION: This page is still a WIP. Usual disclaimers about not taking responsibility for your system disruption applies.

			Note January 2023: a precompiled version of the Miosix toolchain for Mac OS is available in the [[Miosix Toolchain]] page.

	=== Before you begin ===		=== Before you begin ===

Artem.glukhov: Artem.glukhov moved page OSX Quick Start to MacOS Quick Start: renamed the operating system since 2016

2020-07-11T10:37:45Z

Artem.glukhov moved page OSX Quick Start to MacOS Quick Start: renamed the operating system since 2016

← Older revision	Revision as of 10:37, 11 July 2020
(No difference)

Artem.glukhov: Added cleanup script part and

2020-07-11T10:36:22Z

Added cleanup script part and

← Older revision		Revision as of 10:36, 11 July 2020
Line 213:		Line 213:
	cd miosix-kernel/miosix/_tools/compiler/gcc-9.2.0-mp3.1		cd miosix-kernel/miosix/_tools/compiler/gcc-9.2.0-mp3.1
	</source>		</source>
			If you prefer to have the toolchain in a different folder from the kernel tree, move this folder in another directory and then continue.

	'''Toolchain dependencies download'''		'''Toolchain dependencies download'''
Line 250:		Line 251:

	SUDO=		SUDO=

	</source>		</source>

			One can decide to install the toolchain globally, in that case uncomment the correct lines and substitute /opt with /usr/local/opt

	We can now finally run the compilation script. From terminal, run:		We can now finally run the compilation script. From terminal, run:
Line 308:		Line 309:

	in order to reload the bash profile script.		in order to reload the bash profile script.

			In order to remove temporary and log files run from the terminal:
			<source lang="bash">
			sh cleanup.sh
			</source>

			This script will remove log files and temporary files created during the installation process, but will keep the downloaded files, so that it will be possible to run install-script.sh again without the need for redownloading anything.

	=== Kernel compilation ===		=== Kernel compilation ===