From d84e953034a95b7f2304558b238a6284749eccb3 Mon Sep 17 00:00:00 2001 From: Huaqi Fang <578567190@qq.com> Date: Fri, 5 Jan 2024 11:45:33 +0800 Subject: [PATCH] doc: help us to improve this nuclei tools and its doc guide Signed-off-by: Huaqi Fang <578567190@qq.com> --- README.md | 8 ++++++++ source/ide/intro.rst | 5 +++++ source/overview/intro.rst | 10 ++++++++++ 3 files changed, 23 insertions(+) diff --git a/README.md b/README.md index 77a6089..24a8b7c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/source/ide/intro.rst b/source/ide/intro.rst index 2f682ae..2980c5c 100644 --- a/source/ide/intro.rst +++ b/source/ide/intro.rst @@ -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 ------------------- diff --git a/source/overview/intro.rst b/source/overview/intro.rst index 41a7b29..a7b0a7c 100644 --- a/source/overview/intro.rst +++ b/source/overview/intro.rst @@ -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