Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
docs(README): updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
kaosat-dev authored Jan 11, 2018
1 parent aed7c34 commit 7581451
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@ A LOT OF THE THINGS HERE CAN AND WILL CHANGE!! This softare is pre-alpha, use at

- this app works pretty much like the web based OpenJSCAD.org
(but does not included a text editor, see below)
- it automatically saves & reloads most settings and the last design you were working on on restart
- there is basic theming support (only two are present, you can change them but not add more at this time)
- uses the shiny new 3D viewer based on regl
- uses most.js observables & a declarative approach internally


### what is supported:
* almost all of the features of OpenJSCAD EXCEPT
* almost all of the features of OpenJSCAD EXCEPT the things in the paragraph below

### what is not supported
- the include() function , [since include is EVIIIL and an antipattern
Expand Down Expand Up @@ -64,6 +69,26 @@ to start the app, in the root folder , type
npm run dev
```

- drag & drop a jscad/js file to get started
- left/right drag to rotate camera
- shift + drag to pan
- double click to reset camera & controls
- tripple click to zoomToFit on the items in the scene
- there are also keyboard shortcuts for camera angles and orthographic/perspective you can take a look at them & change them in the data/keybindings.json file (requires restart)

  * `t` : top view
* `b` : bottom view
* `l` : left view
* `r` : right view
* `f`: front view
* `b`: back view
(yes 'b' is bound to both bottom & back views, whoops)
* warning ! panning is broken in orthographic mode
* `p`: perspective projection
* `o`: orthographic projection
- most of the ui options should be explicit


## License

[The MIT License (MIT)](./LICENSE)
Expand Down

0 comments on commit 7581451

Please sign in to comment.