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

Initial documentation #8

Closed
philthompson10 opened this issue Jan 23, 2024 · 0 comments
Closed

Initial documentation #8

philthompson10 opened this issue Jan 23, 2024 · 0 comments
Assignees
@philthompson10
Labels
documentation Improvements or additions to documentation

Comments

@philthompson10
Copy link
Contributor

philthompson10 commented Jan 23, 2024 •
edited

Some initial documentation needs to be created containing the following sections:

  • an introduction similar to README.md
  • the specification of the directory structure of a generated metasip project including external .sip files, C/C++ code etc.
  • release history (replacing the NEWS file).

To be hosted at readthedocs.
@philthompson10 philthompson10 added the documentation Improvements or additions to documentation label Jan 23, 2024
@philthompson10 philthompson10 self-assigned this Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philthompson10 philthompson10

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@philthompson10