Skip to content

Commit 017d885

Browse files
committed
doc: optimize Nuclei SDK README.md
1 parent 0f6d664 commit 017d885

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55

66

77
> [!NOTE]
8-
> If you want to build and run on Nuclei 100 series CPU, please switch to **develop_n100** or **master_n100** branch.
8+
> If you want to build and run on Nuclei 100 series CPU, please switch to [**develop_n100**][3] or [**master_n100**][2] branch.
99
1010
> Since 0.5.0 release, Nuclei Studio >= 2023.10 and Nuclei RISC-V Toolchain/Qemu/OpenOCD >= 2023.10 are required to build and run.
1111
1212
**Nuclei Software Development Kit(Nuclei SDK)** is developed for developing and evaluating software for Nuclei Evaluation SoC.
1313

1414
![Nuclei SDK Diagram](doc/source/asserts/images/nuclei_sdk_diagram.png)
1515

16-
This Nuclei SDK is built based on the **NMSIS** framework, user can access all the APIs provided by **NMSIS** and also the APIs that provided by Nuclei SDK which mainly for on-board peripherals access such as GPIO, UART, SPI and I2C etc.
16+
This Nuclei SDK is built based on the [**NMSIS**][7] framework, user can access all the APIs provided by **NMSIS** and also the APIs that provided by Nuclei SDK which mainly for on-board peripherals access such as GPIO, UART, SPI and I2C etc.
1717

18-
This Nuclei SDK can support various compiler such as Nuclei riscv gcc/clang, IAR compiler and Terapines ZCC.
18+
This Nuclei SDK can support various compiler such as [Nuclei RISC-V GCC/Clang][4], [IAR compiler][5] and [Terapines ZCC][6].
1919

2020
We also integrated many RTOSes into Nuclei SDK, which are **FreeRTOS**, **UCOSII**, **RTThread** and **ThreadX**, you can easily find it in the *OS* folder.
2121

@@ -29,10 +29,10 @@ Wanner to take a try with **Nuclei N100 SDK for Nuclei 100 series CPU**, click [
2929

3030
## Requirements
3131

32-
* Ubuntu Linux >=20.04 LTS or Windows >=7
32+
* Ubuntu Linux >=20.04 LTS or Windows >=10
3333
- **Linux**: GNU Make >= 3.82
3434
- **Windows**: [Windows Build Tools](https://nucleisys.com/download.php)
35-
* [Nuclei Studio >= 2024.06](https://nucleisys.com/download.php)
35+
* [Nuclei Studio >= 2025.02](https://nucleisys.com/download.php)
3636
- Nuclei Studio can support import Nuclei SDK NPK package to provide IDE project wizard create/build/debug.
3737
- Nuclei Studio also contains same release of Nuclei Toolchain/QEMU/OpenOCD, so just download IDE is enough.
3838

@@ -293,3 +293,9 @@ changed from `riscv-nuclei-elf-` to `riscv64-unknown-elf-`.
293293

294294

295295
[1]: https://doc.nucleisys.com/nuclei_sdk/design/app.html#cpuinfo
296+
[2]: https://github.com/Nuclei-Software/nuclei-sdk/tree/master_n100
297+
[3]: https://github.com/Nuclei-Software/nuclei-sdk/tree/develop_n100
298+
[4]: https://nucleisys.com/download.php#tools
299+
[5]: https://iar.com/riscv
300+
[6]: https://www.terapines.com/products/zcc
301+
[7]: https://doc.nucleisys.com/nmsis

0 commit comments

Comments
 (0)