UCL / TDMS

Time Domain Maxwell Solver
https://github-pages.ucl.ac.uk/TDMS
GNU General Public License v3.0
12 stars 4 forks source link

Add troubleshooting instructions to README.md #323

Closed samcunliffe closed 1 year ago

samcunliffe commented 1 year ago

Related to the discussion in

I propose to add some "Troubleshooting" instructions to README.

Question

Should the MATLAB file format v7.3 instructions also go inside the troubleshooting <details> tags? I.e. Hidden by default.

Pros:

Cons:

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (abf505a) 25% compared to head (0701652) 25%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #323 +/- ## =================================== Coverage 25% 25% =================================== Files 66 66 Lines 3607 3607 =================================== Hits 908 908 Misses 2699 2699 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

samcunliffe commented 1 year ago

To answer the question posed in the PR: it's probably worth mentioning the save-file format thing somewhere visible, then referring readers to the troubleshooting section from there (since this is quite a fundamental problem that blocks use of TDMS, but is simultaneously not our fault).

Yeah, OK. Let's leave as is for now then.

Perhaps more generally, the README is getting quite long now. Maybe we should contemplate the idea of doc/troubleshooting.md? (and any other sensible breakouts while we're at it)

Well #292 / #296 will make it worse 😸

I'm open to troubleshooting.md but perhaps a longish readme is unavoidable. Maybe better to have everything in one place rather than referencing back and forth to a separate help page.

Let's merge this as is for now.