Skip to content

Commit 4df1669

Browse files
authored
Improve documentation (#4)
1 parent 2187b99 commit 4df1669

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# Platform SDK C#
22

3+
[![Build status](https://badge.buildkite.com/72262ae19b377e0bb4b73b28a6e364eb903cc617cd7de9a962.svg)](https://buildkite.com/improbable/platform-sdk-csharp-nightly)
4+
35
This repository contains both the source code of the Platform SDK C# and a collection of common scenarios that demonstrate how to interact with the SpatialOS Platform SDK using the SDK.
46

57
*Note: A copy of [SpatialOS blank_project](https://github.com/spatialos/BlankProject) is checked in as an example to use with some scenarios. If you are looking for SpatialOS starter projects, please visit [SpatialOS GitHub](https://github.com/spatialos).*
68

9+
## Example scenarios
10+
11+
The design of the SDK is driven by scenarios we want to enable for our users. For detailed implementations of these scenarios, please visit [the examples directory](examples). You can use the scenarios as a quick way to experiment with the SDK.
12+
13+
## Targeted framework
14+
15+
The C# SDK is currently built targeting .NET Framework 4.5.1 and .NET Standard 1.5. As a result, it will work on all supported platforms.
16+
17+
## Contributing
18+
19+
We are currently not accepting external contributions. However, we're keen to hear what you think, so if you have any suggestions for improvements, please raise a GitHub issue and we will respond to it.
20+
721
## Licensing
822

9-
* See [LICENSE](LICENSE.md)
23+
* See [LICENSE](LICENSE.md)

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
You can build and run the C# solution in an IDE, or using the .NET Core CLI.
99

1010
### Using an IDE
11-
1. Open [csharp.sln](csharp.sln) in your preferred IDE, configured to use the .NET Core Runtime.
11+
1. Open [examples.sln](examples.sln) in your preferred IDE, configured to use the .NET Core Runtime.
1212
2. Run any of the projects in the solution.
1313

1414
### Using the .NET Core CLI

0 commit comments

Comments
 (0)