Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Document] Add documentation for Nuclei SDK #2

Closed
8 tasks done
fanghuaqi opened this issue Jan 19, 2020 · 1 comment
Closed
8 tasks done

[Document] Add documentation for Nuclei SDK #2

fanghuaqi opened this issue Jan 19, 2020 · 1 comment
Assignees
@fanghuaqi
Labels
documentation Improvements or additions to documentation
Projects
Nuclei SDK Release 0.3.0

Comments

@fanghuaqi
Copy link
Member

fanghuaqi commented Jan 19, 2020 •
edited

Feature: Add documentation for Nuclei SDK

Tasks need to be done:

  • Add documentation structure using Sphinx and reStructuredText
  • Document about Nuclei SDK source code structure and NMSIS
  • Document about Build system of Nuclei SDK
  • Document about Nuclei SDK supported Board
    - Must describe the board's necessary information, so software developer can easily use this board without looking into the hardware manual too much
    - Must contain nessary steps about how to use Nuclei SDK on this board
  • Document about the applications and how to run
  • Document about how to add a new application
  • Document about how to add new BSP support in Nuclei SDK
  • Document about contributing guide
@fanghuaqi fanghuaqi self-assigned this Jan 19, 2020
@fanghuaqi fanghuaqi added the documentation Improvements or additions to documentation label Jan 19, 2020
@fanghuaqi fanghuaqi added this to In progress in Nuclei SDK Release 0.3.0 Jan 19, 2020
@fanghuaqi
Copy link
Member Author

Fixed in commit 6f4808b

Nuclei SDK Release 0.3.0 automation moved this from In progress to Done Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fanghuaqi fanghuaqi

Labels
documentation Improvements or additions to documentation
Projects
No open projects
Nuclei SDK Release 0.3.0
  
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fanghuaqi