Adam HathcockCore
Disclaimer
This is an early alpha release, not meant for use in production! We're working to stabilise the 2.0 API, and until then there will be breaking changes. You have been warned!
Introduction
Core
Core is the .NET SDK for Speckle 2.0. It uses .NET Standard 2.0 and has been tested on Windows and MacOS.
Documentation
Comprehensive developer and user documentation can be found in our:
📚 Speckle Docs website
Developing & Debugging
Building
Make sure you clone this repository together with its submodules: git clone https://github.com/specklesystems/Core.git -recursive.
Afterwards, just restore all the NuGet packages and hit Build!
Developing
This project is evolving fast, to better understand how to use Core we suggest checking out the Unit and Integration tests. Running the integration tests locally requires a local server running on your computer.
We'll be also adding preliminary documentation on our forum.
Tests
There are two test projects, one for unit tests and one for integration tests. The latter needs a server running locally in order to run.
Contributing
Before embarking on submitting a patch, please make sure you read:
Community
The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!
License
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license.
Objects
Status
Introduction
Before venturing any further please make sure to check the following:
Objects
The Speckle 2.0 object model: geometry and element base classes. It uses .NET Standard 2.0 and has been tested on Windows and MacOS.
NOTE: this is the default object model we ship with Speckle. You can develop your own or fork this and extend it too!
More info on Objects and Kits 2.0 can be found in this community forum thread.
Documentation
Comprehensive developer and user documentation can be found in our:
📚 Speckle Docs website
Developing & Debugging
Building
Just restore all the NuGet packages and hit Build!
Developing
Objects is just a set of Data Transfer Objects, it's quite straightforward to understand how they work!
Host application support
In order to better support interop between the various AEC host applications and Speckle, Objects also contains classes that help to deal with native object types and their properties.
For example, you'll see a \Revit folder. That contains a series of classes that extend the basic ones with a series of default Revit properties. This is the approach we'll follow with other host applications as well.
Contributing
Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.
Community
The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!
License
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license.