Skip to content

Commit

Permalink
doc: help us to improve this nuclei tools and its doc guide
Browse files Browse the repository at this point in the history
Signed-off-by: Huaqi Fang <[email protected]>
  • Loading branch information
fanghuaqi committed Jan 5, 2024
1 parent 69cfe13 commit d84e953
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@

This repo contains guide about Nuclei Tools including Nuclei Studio, Toolchain, Qemu, OpenOCD.

If you have issues in this user guide, please send us an pull request to help us improve it.

If you have issues in our Nuclei Tools, please send us an issue in this repo or related tool repo to help us improve it.
- Nuclei Studio: https://github.com/Nuclei-Software/nuclei-studio
- Nuclei RISC-V Toolchain: https://github.com/riscv-mcu/riscv-gnu-toolchain
- Nuclei OpenOCD: https://github.com/riscv-mcu/riscv-openocd
- Nuclei Qemu: https://github.com/riscv-mcu/qemu
- Nuclei DLink: https://github.com/nuclei-Software/nuclei-dlink
5 changes: 5 additions & 0 deletions source/ide/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
Introduction
============

Currently documentation is still yet ready in English version, please check Chinese version below:

- Nuclei Studio User Guide: https://nucleisys.com/upload/files/doc/nucleistudio/Nuclei_Studio_User_Guide.202310.pdf
- Nuclei Studio FAQ: https://www.rvmcu.com/nucleistudio-faq.html

About Nuclei Studio
-------------------

Expand Down
10 changes: 10 additions & 0 deletions source/overview/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ which works with Nuclei SDK and Nuclei Linux SDK.
To get a pdf version of this documentation, please click `Nuclei Development Tool User Guide`_

.. _Nuclei Development Tool User Guide: ../nuclei_tool_user_guide.pdf


If you have issues in this user guide, please send us an pull request in https://github.com/Nuclei-Software/nuclei-tool-guide repo to help us improve it.

If you have issues in our Nuclei Tools, please send us an issue in this repo or related tool repo to help us improve it.
- Nuclei Studio: https://github.com/Nuclei-Software/nuclei-studio
- Nuclei RISC-V Toolchain: https://github.com/riscv-mcu/riscv-gnu-toolchain
- Nuclei OpenOCD: https://github.com/riscv-mcu/riscv-openocd
- Nuclei Qemu: https://github.com/riscv-mcu/qemu
- Nuclei DLink: https://github.com/nuclei-Software/nuclei-dlink

0 comments on commit d84e953

Please sign in to comment.