Matteo Cominetti
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# The Speckle Viewer
|
|
|
|
[](https://twitter.com/SpeckleSystems) [](https://discourse.speckle.works) [](https://speckle.systems) [](https://speckle.guide/dev/)
|
|
|
|
## 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:
|
|
|
|
#### 📚 [Speckle Docs website](https://speckle.guide/dev/)
|
|
|
|
## Getting started
|
|
|
|
Note, these are WIP instructions. For development purposes, to start a webpack live reload server run:
|
|
|
|
```
|
|
npm run serve
|
|
```
|
|
|
|
To build the library, you should run:
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
## Community
|
|
|
|
If in trouble, the Speckle Community hangs out on [the forum](https://discourse.speckle.works). 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. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems).
|