YAPP_Box icon indicating copy to clipboard operation
YAPP_Box copied to clipboard

Clarify include and function needed for basic operation

Open zyphlar opened this issue 1 year ago • 1 comments

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!

zyphlar avatar Mar 12 '24 19:03 zyphlar

@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 avatar Mar 15 '24 05:03 mrWheel

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

Please read and give comment's.

mrWheel avatar Jun 11 '24 08:06 mrWheel

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!

zyphlar avatar Jun 12 '24 15:06 zyphlar

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.

mrWheel avatar Jun 12 '24 17:06 mrWheel

Looks good thanks!

zyphlar avatar Jun 12 '24 17:06 zyphlar