From 2429d9d45acdddf963812121875c882a68b18ed8 Mon Sep 17 00:00:00 2001 From: Wil Chung Date: Mon, 7 May 2012 16:29:06 -0700 Subject: added a getting started section to the README diff --git a/README.md b/README.md index 7cb5e34..fe6fb50 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # What is OpenSCAD? OpenSCAD is a software for creating solid 3D CAD objects. It is free software @@ -25,6 +24,32 @@ addition to 2D paths for extrusion it is also possible to read design parameters from DXF files. Besides DXF files OpenSCAD can read and create 3D models in the STL and OFF file formats. +# Getting started + +You can download the latest binaries of OpenSCAD at . Install binaries as you would any other software. + +When you open OpenSCAD, you'll see three frames within the window. The left frame is where you'll write code to model 3D objects. The right frame is where you'll see the 3D rendering of your model. + +Let's make a tree! Type the following code into the left frame: + + cylinder(h = 30, r = 8); + +Then render the 3D model by hitting F5. Now you can see a cylinder for the trunk in our tree. Now let's add the bushy/leafy part of the tree represented by a sphere. To do so, we will union a cylinder and a sphere. + + union() { + cylinder(h = 30, r = 8); + sphere(20); + } + +But, it's not quite right! The bushy/leafy are around the base of the tree. We need to move the sphere up the z-axis. + + union() { + cylinder(h = 30, r = 8); + translate([0, 0, 40]) sphere(20); + } + +And that's it! You made your first 3D model! There are other primitive shapes that you can combine with other set operations (union, intersection, difference) and transformations (rotate, scale, translate) to make complex models! Check out all the other language features in the [OpenSCAD Manual](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual). + # Documentation Have a look at the OpenSCAD Homepage (http://openscad.org/) for documentation. -- cgit v0.10.1