search

mrWheel / YAPP_Box

Yet Another Parametric Projectbox Box
https://willem.aandewiel.nl/index.php/2022/01/02/yet-another-parametric-projectbox-generator/
MIT License
276 stars 46 forks source link

Clarify include and function needed for basic operation #76

Closed zyphlar closed 5 months ago

zyphlar commented 8 months ago

Following what's in Git and GitBook it's not mentioned that you need include <YAPP_Box-3.0.1/YAPPgenerator_v3.scad> at the top of the file and YAPPgenerate(); at the bottom. Only by reading the blog post did I infer those details.

Ideally in the What You Need section of the Book and the How to program your Project Box section of the Readme these details will be added so that a newbie can copy-paste and get basic output in OpenSCAD before continuing, sort of a Hello World to ensure that things are installed correctly.

Indeed the instructions talk about putting YAPP in the libraries folder, but then the blog post tells you to include the file with a relative path, which can confuse people who aren't experts.

Thanks for this great library!

mrWheel commented 8 months ago

@zyphlar,

You are right! But I’m currently very busy with an other project and don’t have the time for at least the next month!

mrWheel commented 5 months ago

I have updated "What you need" and "Getting Started" in gitbook.

Please read and give comment's.

zyphlar commented 5 months ago

Looks good! The only part I noticed was that "It is wise to leave the folder structure as it is and save new box designs in this “YAPP_Box-main” folder." is obsolete with all the other instructions about the pros and cons of where to install the library

Thank you!

mrWheel commented 5 months ago

The only part I noticed was that "It is wise to leave the folder structure as it is and save new box designs in this “YAPP_Box-main” folder." is obsolete with all the other instructions about the pros and cons of where to install the library

I made some minor changes to the text.

zyphlar commented 5 months ago

Looks good thanks!