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

Each directory could have a README.md that shows screenshots #188

Open
luzpaz opened this issue Feb 16, 2017 · 12 comments
Open

Each directory could have a README.md that shows screenshots #188

luzpaz opened this issue Feb 16, 2017 · 12 comments

Comments

@luzpaz
Copy link
Contributor

luzpaz commented Feb 16, 2017

...this would help folks browse the repo instead of needing to download files to view their contents.

luzpaz added a commit to luzpaz/FreeCAD-library that referenced this issue Feb 16, 2017
Obijuan added a commit that referenced this issue Feb 16, 2017
@Obijuan
Copy link
Member

Obijuan commented Feb 16, 2017

I think it is a great idea!

@luzpaz
Copy link
Contributor Author

luzpaz commented Feb 16, 2017

@Obijuan thanks :)
Perhaps you can make it a guideline that it become part of the contribution workflow to make a png of their submission and at it as a README.md to said directory ?

luzpaz added a commit to luzpaz/FreeCAD-library that referenced this issue Feb 17, 2017
These are skeleton README.md files as mentioned in FreeCAD#188 for:
Architectual Parts/
Electronic Parts/
@luzpaz
Copy link
Contributor Author

luzpaz commented Feb 17, 2017

Ideas for submissions guidelines:

  • must be submitted with a README.md file
  • README.md template (needs to be decided on)
  • image format (png?) must be certain size
  • image name must not have white space in it.

@infthi
Copy link
Contributor

infthi commented Apr 24, 2017

FIY github has a built-in viewer for stl files

@battlesnake
Copy link

Could possibly have a script hooked to the repo the generates several views of each part and publishes them to a separate repo/site/archive rather than putting them in the source repo, to prevent the size from ballooning too rapidly

@yorikvanhavre
Copy link
Member

That might be a good idea, but it would require a server to run this script, etc...
At the moment the library weights more or less 1Gb, including:

  • The .git folder (not present if you dont use git): 315Mb
  • jpg files: 512Kb
  • png files: 1.7Mb
  • step files: 342Mb
  • stl files: 164Mb
  • brep files: 161Mb
  • FCStd files: 143Mb

So the image files really are very small, not even 1% of the total size. Also, FreeCAD has the ability to save a thumbnail inside the file, which would make these image files not necessary...

What we should do, maybe, is try to get rid of all the brep and step files. For that, we should better the tools in FreeCAD to offer several ways to import an FCStd file, to make these additional formats unnecessary (basically the ability to import them as one object). Then, make sure every brep or step file here has a corresponding FCStd file.

@silopolis
Copy link

silopolis commented May 10, 2019 via email

@easyw
Copy link

easyw commented May 10, 2019

@yorikvanhavre
we could remove brep format (which adds nothing compared to .FCStd file) ...
STEP files are a bit depending on what release of FC is used to export and which options are selected... so I would keep this format in the library... eventually they can be added as zip or even as '.stpZ' format (which is a zip std step format that can be read and saved in FC).
The file size will drop 10 times or more normally...
Also STL could be saved as zip

@yorikvanhavre
Copy link
Member

stl is useful because you can visualize them in 3D in github (who knows one day they support FCStd files 😄 )
Probably the best way to proceed with all this is not to have the parts library as a simple FreeCAD addon anymore, but a separate system where you can download parts on-the-fly, as you need, and not simply download the whole thing as a bundle... But that requires basically coding a whole new system for it. If anyone is interested in doing that, I'm interested in helping ;)

@battlesnake
Copy link

battlesnake commented May 13, 2019 via email

@yorikvanhavre
Copy link
Member

I could possibly take that on, but not for a few months due to current paid projects.

That would be great!!

This can be pretty simple... A dialog that basically shows a tree structure with files, and on double-clicking any of them it would download it and insert it in FreeCAD. There is a working example of this in https://github.com/yorikvanhavre/BIM_Workbench/blob/master/BimLibrary.py but the way the tree is populated there is automatic, from the filesystem. Here we'd need to do it manually.

The most annoying thing would be to get that files & directory structure from github. But maybe there is some cool API functionality to get that...

Cool too would be that such a tool wouldn't prevent using the library as we do now (clone the whole thing locally). It would just be an alternative, online UI for it...

@battlesnake
Copy link

battlesnake commented May 13, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants