/speckle-sharp-sdk

The Speckle SDK/Core for V3

Primary LanguageC#Apache License 2.0Apache-2.0

Core

Twitter Follow Community forum users website docs

codecov

Disclaimer

This is an early alpha release, not meant for use in production! We're working to stabilise the 3.0 API, and until then there will be breaking changes. You have been warned!

Introduction

Core

Core is the .NET SDK for Speckle 3.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:

Developing & Debugging

Building

Make sure you clone this repository together with its submodules: git clone https://github.com/specklesystems/speckle-sharp-sdk.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.