search

rbumm / SlicerLungCTAnalyzer

This is a 3D Slicer extension for segmentation and spatial reconstruction of infiltrated, collapsed, and emphysematous areas in lung CT.
Apache License 2.0
71 stars 23 forks source link

Store screenshots in the repository #12

Closed lassoan closed 3 years ago

lassoan commented 3 years ago

Instead of storing screenshots as issue attachments, they could be stored in a folder (e.g., Docs), because they are not too big. If there are more or larger screenshots then they can be uploaded as a release asset (create a release called DocsResources and upload the screenshots there).

But at least #1, #2, #3 issues should be closed so that they do not pollute the issue tracker.

rbumm commented 3 years ago

Ok, how do I link to the screenshots in the readme then?

lassoan commented 3 years ago

If you store images as release assets then you use absolute URLs. If you store them in the repository then you use relative path, for example ![](SomeScreenshot.png) or ![](Docs/SomeScreenshot.png).

lassoan commented 3 years ago

You can also upload the test data as release asset. Github servers are very fast, reliable, and download speeds are good from anywhere in the world.

rbumm commented 3 years ago

There is an upload size limit to github - what is the recommended way to upload larger files ?

lassoan commented 3 years ago

As far as I know, the a 50MB soft limit and 100MB hard limit only applies to uploading files into the git repository. Do not upload anything big like that there! Screenshots may be OK, as they are only a few hundred KB, but any thing larger would make the repository bloated.

You can upload big files (I think up to 2GB as release assets). Create a new "TestingData" release here and upload test data files by drag-and-drop. If you want to store screenshots as release assets, too, then probably it is cleaner to create separate "DocsResources" release; or keep everything in a release with a generic name, such as "Resources".

rbumm commented 3 years ago

Thanks Andras, will try that. Good morning from Switzerland.