search

JustinSDK / dotSCAD

Reduce the burden of mathematics when playing OpenSCAD
https://openhome.cc/zh-tw/openscad/
GNU Lesser General Public License v3.0
784 stars 107 forks source link

Readme is incomprehensible to newbie #13

Closed sandos closed 3 years ago

sandos commented 3 years ago

The top of the readme for this project does not explain what it is, what it does or what it enhances in openscad. Ok, fair enough, it does say: "Reduce the burden of mathematics when playing OpenSCAD."

The beginning of the first sentence goes on about library install locations for OpenSCAD. But why do I need this information?

Is this a new standard library for openscad, or a new core for openscad? I still do not know.

Adding a section "What this is" to the top of the readme with a sentence or two would help a lot.

JustinSDK commented 3 years ago

Are you an OpenSCAD newbie? If you're an OpenSCAD newbie, what you need is the official documentation. You'll know the standard library is here.

What the libraries tab contains are all 3rd party libraries. Why do you need these libraries? As the examples page says: 

These examples incubate dotSCAD and dotSCAD refactors these examples.

Should I list this sentence on the top of README?

JustinSDK commented 3 years ago

I add some words on the top of README.

Some of my 3D models require complex mathematics/algorithm. I extract them into dotSCAD. Hope it helps when you're playing OpenSCAD.
sandos commented 3 years ago

Thats good enough for me!