Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 1.64 KB

readme.md

File metadata and controls

39 lines (22 loc) · 1.64 KB

The Speckle Viewer

Twitter Follow Community forum users website docs npm version

Disclaimer

We're working to stabilize the 2.0 API, and until then there will be breaking changes.

Documentation

Comprehensive developer and user documentation can be found in our:

Getting started

Note, these are WIP instructions. More details coming soon!

For development purposes, to start a webpack live reload server run:

npm run serve

You can now access the example at http://localhost:9000/example.html.

To build the library, you should run:

npm run build

Community

If in trouble, the Speckle Community hangs out on the forum. Do join and introduce yourself! We're happy to help.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. If you have any questions, don't hesitate to get in touch with us via email.