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

Documentation #48

Closed
10 of 11 tasks
mads-bertelsen opened this issue Feb 11, 2022 · 0 comments
Closed
10 of 11 tasks

Documentation #48

mads-bertelsen opened this issue Feb 11, 2022 · 0 comments

Comments

@mads-bertelsen
Copy link
Contributor

mads-bertelsen commented Feb 11, 2022 •
edited by shervin86
Loading

Overall thoughts:
Users for libpyvinyl are not stupid. Can be precise and short. Use links to the reference when possible.
Subsections are coming to reference manual. Will be easier to link to!

Getting started

  • Overview [1 page of text, what is the problem and how does libpyvinyl solve it]
  • Installation [0.5 page, pip / source and tests]
  • Libpyvinyl projects [0.25 page + links to libpyvinyl packages documentation]
  • Quick start [plus minus example (short), links to projects that use libpyvinyl]

User guide [Perhaps to be done later]

  • BaseCalculator [1 page, purpose / intent]
  • Parameters [1 page, purpose / intent]
  • BaseData [1 page, purpose / intent]
  • BaseFormat [1 page, purpose / intent]
  • Instrument [1 page, purpose / intent]

Developer guide lines

  • How to make a libpyvinyl based package [1 page, basic structure diagram, expanding the base-classes]
  • Plus Minus example [longer version]
@CFGrote CFGrote mentioned this issue Feb 11, 2022
Merged
CFGrote pushed a commit that referenced this issue Feb 11, 2022
Update readme.md
98ce2fb 
Adding material to Problem statement and insert headings according to issue #48
@JunCEEE JunCEEE mentioned this issue Apr 29, 2022
Closed
8 tasks
JunCEEE pushed a commit to JunCEEE/libpyvinyl that referenced this issue May 3, 2022
@JunCEEE
Update readme.md
2e0913a 
Adding material to Problem statement and insert headings according to issue PaNOSC-ViNYL#48
JunCEEE pushed a commit to JunCEEE/libpyvinyl that referenced this issue May 3, 2022
@JunCEEE
Update readme.md
e69ee69 
Adding material to Problem statement and insert headings according to issue PaNOSC-ViNYL#48
JunCEEE pushed a commit that referenced this issue May 17, 2022
@JunCEEE
Update readme.md
b68e535 
Adding material to Problem statement and insert headings according to issue #48
@shervin86 shervin86 mentioned this issue May 18, 2022
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shervin86 @mads-bertelsen