Quick start: Difference between revisions

From Miosix Wiki
Jump to navigation Jump to search
m (Add OS X "Getting Started" and "Netbeans configuration" page references.)
(Better instructions for configuring VSCode.)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
To start using Miosix you need a patched version of the GCC compiler called [[Miosix Toolchain]] and git to download the kernel sources. Optionally you can also use an IDE to simplify code development, and an in-circuit debugger to speed up bug fixing.
To start using Miosix you need a patched version of the GCC compiler called [[Miosix Toolchain]] and git to download the kernel sources. Optionally you can also use an IDE to simplify code development, and an in-circuit debugger to speed up bug fixing.


''' Changes with respect to Miosix 1.x '''
= Getting started =
 
A word of warning if you are a long-time user of Miosix: please note that in Miosix 2.0 there were significant changes.
First of all, Miosix 2.0 uses GCC 4.7.3 and is no longer compatible with the old GCC 4.5.2 used in Miosix 1.x, so you need to upgrade your compiler.
Second, the preferred way to install the compiler is through a precompiled installer available for both Linux and Windows. If you want, though, you can still build the compiler from sources.
Last, keep in mind that the compiler patches are still a work in progress. When doing a 'git pull' you may need to upgrade the compiler too.
 
=== Getting started ===


This section will guide you through the installation of the minimum requirements to start using Miosix: installing the compiler, and downloading the kernel.
This section will guide you through the installation of the minimum requirements to start using Miosix: installing the compiler, and downloading the kernel.
Line 14: Line 7:
* [[Linux Quick Start|Getting Started on Linux]]
* [[Linux Quick Start|Getting Started on Linux]]
* [[Windows Quick Start|Getting Started on Windows]]
* [[Windows Quick Start|Getting Started on Windows]]
* [[OSX Quick Start|Getting Started on OSX]]
* [[MacOS Quick Start|Getting Started on macOS]]
 
= Miosix and git workflow =


=== IDE Configuration ===
See [[Miosix and git workflow]] to understand how to manage the Miosix git repository.


The default IDE to develop for Miosix is [https://netbeans.org/ Netbeans]. However, it does not come with Miosix support out of the box, so you have to configure it first.
= In-circuit debugger =


* [[Linux Netbeans configuration]]
An in-circuit debugger allows to physically halt the CPU inside a microcontroller, single-step it and view all the variables at any given time. It is a powerful tool to debug software running on a microcontroller. Miosix uses GDB and [http://openocd.sourceforge.net openocd] for in-circuit debugging.
* [[Windows Netbeans configuration]]
 
* [[OSX Netbeans configuration]]
* [[Linux Debugger configuration]]
* [[Windows Debugger configuration]]
 
= IDEs =
 
At the moment the simplest way to develop Miosix is to use a plain text editor. Alternatively, you can use any IDE that supports Makefiles to take advantage of features such as autocompletion and/or debugger integration (where available).
 
== Visual Studio Code ==


Another alternative is [[Linux Eclipse configuration|Eclipse]], which has the added feature to allow in-circuit debugging directly from the IDE.
Visual Studio Code is known to work properly on the Miosix source tree with the standard C/C++ and Makefile extensions. After installing these extensions, you need to configure IntelliSense in the C/C++ extension to use the include paths found from the Makefile by setting the ''Configuration provider'' for the workspace to <code>ms-vscode.makefile-tools</code>.


You can also use [http://www.qt.io QtCreator].
Integration with GDB/openocd has not been tested but you can run GDB/openocd manually in the integrated terminal.


* [[Linux QtCreator configuration]]
== Netbeans IDE ==
* [[Windows QtCreator configuration]]


=== Miosix and git workflow ===
'''Important:''' These instructions were developed back when NetBeans was still a Sun product, they are probably outdated by now!


See [[Miosix and git workflow]] to understand how to manage the Miosix git repository.
For a long time the default IDE to develop for Miosix has been [https://netbeans.org/ Netbeans]. NetBeans does not come with Miosix support out of the box, so you have to configure it first.


=== In-circuit debugger ===
* [[Linux Netbeans configuration]]
* [[Windows Netbeans configuration]]
* [[OSX Netbeans configuration]]


An in-circuit debugger allows to physically halt the CPU inside a microcontroller, single-step it and view all the variables at any given time. It is a powerful tool to debug software running on a microcontroller. Miosix uses GDB and [http://openocd.sourceforge.net openocd] for in-circuit debugging.
== Other IDEs ==


* [[Linux Debugger configuration]]
* [[VisualStudio Quick Start|Windows Visual Studio configuration]] using VisualGDB which integrates in-circuit debugging support.
* [[Windows Debugger configuration]]
* [[Linux Eclipse configuration|Eclipse]], which has the added feature to allow in-circuit debugging directly from the IDE.
* [[Linux QtCreator configuration]]
* [[Windows QtCreator configuration]]


[[Category:Installation and Configuration]]
[[Category:Installation and Configuration]]

Latest revision as of 17:30, 17 March 2024

To start using Miosix you need a patched version of the GCC compiler called Miosix Toolchain and git to download the kernel sources. Optionally you can also use an IDE to simplify code development, and an in-circuit debugger to speed up bug fixing.

Getting started

This section will guide you through the installation of the minimum requirements to start using Miosix: installing the compiler, and downloading the kernel.

Miosix and git workflow

See Miosix and git workflow to understand how to manage the Miosix git repository.

In-circuit debugger

An in-circuit debugger allows to physically halt the CPU inside a microcontroller, single-step it and view all the variables at any given time. It is a powerful tool to debug software running on a microcontroller. Miosix uses GDB and openocd for in-circuit debugging.

IDEs

At the moment the simplest way to develop Miosix is to use a plain text editor. Alternatively, you can use any IDE that supports Makefiles to take advantage of features such as autocompletion and/or debugger integration (where available).

Visual Studio Code

Visual Studio Code is known to work properly on the Miosix source tree with the standard C/C++ and Makefile extensions. After installing these extensions, you need to configure IntelliSense in the C/C++ extension to use the include paths found from the Makefile by setting the Configuration provider for the workspace to ms-vscode.makefile-tools.

Integration with GDB/openocd has not been tested but you can run GDB/openocd manually in the integrated terminal.

Netbeans IDE

Important: These instructions were developed back when NetBeans was still a Sun product, they are probably outdated by now!

For a long time the default IDE to develop for Miosix has been Netbeans. NetBeans does not come with Miosix support out of the box, so you have to configure it first.

Other IDEs