h3n3/cadhub
1
0
Fork 0
Code Issues 35 Pull Requests Packages Projects Releases Wiki Activity

Tweak docs and add a single blog post

Browse Source
This commit is contained in:
Kurt Hutten
2021-04-29 20:55:13 +10:00
parent 5bf8ab266a
commit dc4a7e06de
18 changed files with 451 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/getting-started/getting-started.mdx
View File

@@ -3,29 +3,33 @@ title: Getting Started
slug: /
---
To get started click the "+" button on the top right of CadHub
import Image from '@theme/IdealImage';
import plus from '../../static/img/getting-started/plus.png';
import plus from '../../static/img/getting-started/plus.jpg';
import openscadSelect from '../../static/img/getting-started/openscad-select.jpg';
import ide from '../../static/img/getting-started/ide.png';
import cube from '../../static/img/getting-started/cube.jpg';
import hinge from '../../static/img/getting-started/complete-hinge.png';
To get started click the "+" button on the top right of CadHub
<Image img={plus} style={{backgroundSize: 'contain', paddingBottom: '2rem'}} />
<Image img={plus} style={{backgroundSize: 'contain', paddingBottom: '2rem', width: '400px', margin: '0 auto'}} />
Then select OpenSCAD. Note that [CadQuery](https://cadquery.readthedocs.io/en/latest/) is available too, but OpenSCAD is recomended and the rest of this tutorial is based on OpenSCAD.
<Image img={openscadSelect} style={{backgroundSize: 'contain', paddingBottom: '2rem', width: '300px', margin: '0 auto'}} size={300} />
You should now see the OpenSCAD IDE (integrated development environment)
<Image img={ide} style={{backgroundSize: 'contain'}} />
Here we should see the default code in the editor on the left-hand-side, there editor is where we design our CAD parts and we'll cover that more soon. You will also see the result will show up on the right-hand-side along with the console which gives us extra information too. You can click and drag inside the viewer to change the perspective, though the image will only update once you let go of the mouse.
Here we should see the default code in the editor on the left-hand-side, the editor is where we design our CAD parts and we'll cover that more soon. You will also see the result will show up on the right-hand-side (along with the console which gives us extra information). You can click and drag inside the viewer to change the perspective, though the image will only update once you let go of the mouse.
You can also move the object with with right-click and drag, and scrolling will zoom in and out.
### What about the editor?
For that we'll need to learn about the OpenSCAD language. For now, try replacing all of the existing code with `cube([10,10,10]);` and then hit ctrl+s to tell CadHub to render a new image. You should see a cube appear!
For that we'll need to learn about the OpenSCAD language. For now, try replacing all of the existing code with `cube([10,10,10]);` and then hit `ctrl + s` to tell CadHub to render a new image. You should see a cube appear!
<Image img={cube} style={{backgroundSize: 'contain'}} />