3. Get Started

This section lists the needed development tools, Software source codes, and then describes how to get started with Nuclei board development.

3.1. Tools Requirement

  • Nuclei Development Tools

    • RISC-V GNU Toolchain: compiler, linker, assembler, debugger and so on

    • Nuclei OpenOCD: support Nuclei Processor Cores, used for development board

    • Windows build tools: a Windows specific package which provides GNU make, and BusyBox which provides a convenient implementation for sh/rm/echo.

  • Segger Embedded Studio is a complete all-in-one solution for managing, building, testing, and deploying your embedded applications which support RISC-V processors, it provides a GUI based development environment.

  • Tera Term or PuTTY for serial terminal connection. The serial configurations are 115200 baud, 8 bits data, no parity, and 1 stop bit (115200-8-N-1) by default.

3.2. Software Source Codes

3.2.1. Install Nuclei SDK

The Nuclei SDK source code is hosted in a GitHub repository that supports cloning through git, and you also can use http download to get this repo.

Using Git to clone the repository anonymously

git clone https://github.com/Nuclei-Software/nuclei-sdk.git nuclei-sdk

You have successfully checked out a copy of the source code to your local machine.

3.2.2. Install Nuclei board labs

The source codes of Nuclei board labs are assumed to work with Nuclei SDK. Please use git to clone or download the Nuclei Board labs to the root folder of Nuclei SDK.

Using Git to clone the repository anonymously

cd path/to/nuclei-sdk
git clone https://github.com/Nuclei-Software/nuclei-board-labs.git board-labs

If the download is successful, the following folder structure is displayed:

nuclei-sdk
├── application
├── Build
├── board-labs
├── NMSIS
├── OS
├── SoC
└── test

3.2.3. Install Segger Embedded Studio solutions

The solutions used with Segger Embedded Studio for Nuclei board labs are already packaged for users. It is hosted in a GitHub repository, you can use Git clone or http download to get this repo.

Using Git to clone the repository anonymously

git clone https://github.com/riscv-mcu/ses_nuclei_sdk_projects.git nuclei_board_labs

If the download is successful, the following folder structure is displayed:

nuclei_board_labs
├── nuclei-sdk
│   ├── application
│   ├── board-labs
│   ├── Build
│   ├── NMSIS
│   ├── OS
│   ├── SoC
│   └── test
└──rvstar_demos
   ├── rvstar_demos.emProject
   └── rvstar_demos.emSession

3.3. Quick Start

3.3.1. Develop with Nuclei SDK

Nuclei SDK includes Makefile, so you can develop your Nuclei Development Board by using command line mode. There are scripts in it that you need to set up your development environment.

How to develop with Nuclei SDK step by step, please see this online docs.

3.3.2. Develop with Segger Embedded Studio

Segger Embedded Studio is a powerful C/C++ IDE (Integrated Development Environment) for embedded systems, you can work with it to develop your Nuclei Development Board atfer environment setting manually.

How to develop with Segger Embedded Studio step by step, please see this online docs.