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.

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

Improve documentation #5

Open
5 of 9 tasks
rs028 opened this issue Apr 2, 2019 · 0 comments
Open
5 of 9 tasks

Improve documentation #5

rs028 opened this issue Apr 2, 2019 · 0 comments
Assignees
Labels
documentation Issues related with the manual or documentation in the source code. help wanted Extra attention is needed

Comments

@rs028
Copy link
Collaborator

rs028 commented Apr 2, 2019

  • Add LaTeX files (including figures) of the manual to the doc/ folder, so that it can be updated.
  • Add a CHANGELOG.md file to the main directory summarizing the changes since version 7.4.1
  • Add a CREDITS.md file to the main directory with the names of everybody who has contributed code over the years (this may require some digging, so let's start with the current list of names).
  • Any outstanding issues and things to do/check/fix/improve (and other things that need to be kept in mind for future development) should be listed as open issue on the github issues page.
  • A couple of items are listed in src/changelog.txt and should be moved to the github issues page.
  • There needs to be a little more explanation on how to use the model than the few lines in the README file.
  • Expand text in the README and convert to markdown (README.md ).
  • The scripts in plots/ require ferret, which should be listed as requirement in the readme file.
  • Document usage of namelists/ and param/ (see issue namelists and param #21).
@pb866 pb866 added the documentation Issues related with the manual or documentation in the source code. label Apr 2, 2019
@rs028 rs028 added this to Issues of Mistra-related repos (KPP, documentation...) in Development Plan Apr 4, 2019
This was referenced Apr 6, 2019
@rs028 rs028 assigned rs028 and pb866 Apr 14, 2019
@rs028 rs028 mentioned this issue Apr 29, 2019
3 tasks
@rs028 rs028 added the help wanted Extra attention is needed label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related with the manual or documentation in the source code. help wanted Extra attention is needed
Projects
No open projects
Development Plan
Issues of Mistra-related repos (KPP, ...
Development

No branches or pull requests

2 participants