Adam Hathcock
405f3f4ee4
* renamespace * add to sln and move * manage package centrally * add sourcelink and use GlobalPackageReference * properly use globals * fix nuget push * fix readme * add namespace handling for new types * Removing used classes to stop viral spread of dependencies. Some JSON usage was STJ and not newtonsoft * fmt * initial test * serialization namespace test * fmt * put back old namespaces * fix tests * fixes while trying to do a roundtrip test * remove namespace fix
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
# Core
|
|
|
|
[](https://twitter.com/SpeckleSystems) [](https://discourse.speckle.works) [](https://speckle.systems) [](https://speckle.guide/dev/)
|
|
|
|
## **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 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:
|
|
|
|
### 📚 [Speckle Docs website](https://speckle.guide/dev/)
|
|
|
|
## 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](https://discourse.speckle.works/c/speckle-insider/10).
|
|
|
|
### 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:
|
|
|
|
- [Contribution Guidelines](CONTRIBUTING.md),
|
|
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
|
|
## Community
|
|
|
|
The Speckle Community hangs out on [the forum](https://discourse.speckle.works), 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.
|