forked from terrafx/terrafx.interop.windows
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md added info on getting started as user.
CONTRIBUTING.md added sections Pull Request Workflow and Coding Conventions. refs terrafx#48
- Loading branch information
1 parent
48aed52
commit 881891f
Showing
2 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ Interop bindings for Windows. | |
* [License](#license) | ||
* [Code of Conduct](#code-of-conduct) | ||
* [Contributing](#contributing) | ||
* [Using](#using) | ||
|
||
### Goals | ||
|
||
|
@@ -45,6 +46,30 @@ wiki, etc) must abide by the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md). | |
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. | ||
|
||
### Using | ||
To use TerraFX you need to not only | ||
**clone the [github repository](https://github.com/terrafx/terrafx.interop.windows)** | ||
but also make sure you have the right tools and libraries installed. | ||
|
||
For Windows 10 you need | ||
[Visual Studio 2019 Preview](https://visualstudio.microsoft.com/vs/preview/) | ||
in its current release (Preview 6 as of the time of this writing) and you need | ||
**.Net 5.0 Preview** (the name is not .Net Core 5.0). | ||
And finally, in Visual Studio you need need to go to | ||
**Options -> Environment -> Preview Features** | ||
and there enable the option **Use previews of the .NET Core SDK**. | ||
|
||
With all requirements in place, start with **TerraFX.Interop.Windows.sln** | ||
in the root directory of the repository. | ||
It will run a few minimalistic examples of using the **TerraFX windows interop API**, | ||
such as rendering a triangle into a DirectX 11 or 12 window. | ||
More examples are being added over time. | ||
**TerraFX.Interop.Windows.Samples.sln** is the second project you might want to try. | ||
It also has minimalistic examples but instead of a full screen window, | ||
the DirectX rendering is embedded into a GUI with buttons and a panel for the rendering. | ||
|
||
Those examples should get you started with using DirectX via C# in your own projects. | ||
|
||
### Contributing | ||
|
||
If you are looking to contribute you should read our | ||
|