Improve the readme.md doco

ostat / gridfinity_extended_openscad

Gridfinity Extended OpenSCAD Model

https://docs.ostat.com/docs/openscad/gridfinity-extended

MIT License

183 stars 19 forks source link

Improve the readme.md doco #45

Open ostat opened 2 months ago

ostat commented 2 months ago

This file should include

a summary of the project.
how to use it (download, clone or online)
where the doco is
what version of openscad you need
what openscad settings need to be enabled
- increase rendering count #3

danielsan80 commented 6 days ago

@ostat could you give me in advance infos about Openscad version I need and which dev environment I need to contribute in developement (using git clone)?

For example I have some sintax errors like

 let(
    efficientFloor = validateEfficientFloor(settings[iCupBase_EfficientFloor]),
    magnetEasyRelease = validateMagnetEasyRelease(settings[iCupBase_MagnetEasyRelease], efficientFloor), // <------
  )

for the comma after the last var.

Maybe is a new feature of the master version of Openscad?

Thankyou

ostat commented 6 days ago

Inside the developer version of OpenSCAD on windows. The trailing comma does not cause an issue on my setup. But it should not be there as it will cause issues with other setups, specifically I know makersworld does not like it. So I will get that fixed. I have been doing a bit of refactoring, to support some new features, I just have missed that one.

danielsan80 commented 5 days ago

The stable and downloadable version is 2021.01. The trailing comma is a good and practical feature but is not available in 2021.01 version. Anyway I'll try to switch to the dev version on Linux.