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

Getting started guide #37

Closed
mraleson opened this issue Aug 1, 2023 · 2 comments
Closed

Getting started guide #37

mraleson opened this issue Aug 1, 2023 · 2 comments

Comments

@mraleson
Copy link

mraleson commented Aug 1, 2023

I think it would be nice if there was a simple getting started document. When I found SolidPython took me a little effort to work through the OpenSCAD, old SolidPython documentation, and new SolidPython2 code/examples.

Would there be any interest if I wrote a getting started tutorial of sort in markdown? If so, where is the best place to put it? I could begin by creating a getting_started.md document?

@jeff-dh
Copy link
Owner

jeff-dh commented Aug 1, 2023

Yeah, sure.....

I see / saw the README and the examples as getting started / tutorial, but I agree -- at least the README -- is a little messy and not well structured / organized and the examples might assume OpenSCAD knowledge.

I guess I'm fine with everything. Rewriting the README, adding and extra Getting Started document (and extracting the "getting started" part into it from the README),......
I guess it might make sense to have somehow two different "entry points" into solidpython. One for people already familiar with OpenSCAD and one for people who are not.

Intuitively I would suggest to split the README up into several documents. I would probably also extract the whole "Version 2.0" section.

@mraleson
Copy link
Author

mraleson commented Aug 3, 2023

I created a pull request #40

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

2 participants