# platform-nuclei

**Repository Path**: Nuclei-Software/platform-nuclei

## Basic Information

- **Project Name**: platform-nuclei
- **Description**:  Nuclei: development platform for PlatformIO
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 1
- **Created**: 2020-01-21
- **Last Updated**: 2025-07-07

## Categories & Tags

**Categories**: risc-v

**Tags**: None

## README

# Nuclei: development platform for [PlatformIO](https://platformio.org)

[![Build Examples](https://github.com/Nuclei-Software/platform-nuclei/actions/workflows/build.yml/badge.svg?branch=feature%2Fgd32vw55x)](https://github.com/Nuclei-Software/platform-nuclei/actions/workflows/build.yml)

> [!NOTE]
>
> If you want to use **platform-nuclei** with latest nuclei sdk(>=0.6.0) and toolchain offline, please follow
> the steps list in [.github/workflows/build.yml](.github/workflows/build.yml).
> 
> Here is a [sample online doc](https://doc.weixin.qq.com/doc/w3_ASUAMQZqALwutPQJm8OTOOPy1OobX?scode=ABcAKgdSAFcdHdWdviASUAMQZqALw) in chinese to tell you how to use **platform-nuclei** for [GD32VW553H Evaluation Kit](https://www.gigadevice.com/product/mcu/risc-v/gd32vw553kmq7).
>
> And you can also take a try with **Nuclei Studio IDE**, which is built on Eclipse embedded CDT, see https://www.nucleisys.com/download.php#tools
>
> If you want **better online platformio support for you and your customer**, **highly recommended** to use https://registry.platformio.org/ 

[Nuclei System Technology](https://www.nucleisys.com/) is a professional RISC-V IP product company.
It provides various RISC-V IP products which can meet the requirements of the AIoT era.
It is the first RISC-V Core IP provider company in Mainland China, launchs the world's
first mass production general-purpose MCU based on RISC-V together with GigaDevice,
see https://www.gigadevice.com/products/microcontrollers/gd32/risc-v/, and is also
the RISC-V eco-system leader in Mainland China.

* [Home](https://platformio.org/platforms/nuclei) (home page in PlatformIO Platform Registry)
* [Documentation](http://docs.platformio.org/page/platforms/nuclei.html) (advanced usage, packages, boards, frameworks, etc.)

# Usage

1. [Install PlatformIO](https://platformio.org)
2. Create PlatformIO project and configure a platform option in [platformio.ini](http://docs.platformio.org/page/projectconf.html) file:

## Stable version

```ini
[env:stable]
platform = nuclei
board = ...
...
```

## Development version

```ini
[env:development]
platform = https://github.com/Nuclei-Software/platform-nuclei.git
board = ...
...
```

# Configuration

Please navigate to [documentation](http://docs.platformio.org/page/platforms/nuclei.html).