Skip to content

Commit 6574bc0

Browse files
committed
doc: moved building to contributing
1 parent 907bea9 commit 6574bc0

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,15 @@ For now, to ease in maintainability, entities are within the `Entity/` folder bu
4949

5050
See the README for more about building and testing your version.
5151

52+
## 📦 Building & Testing
53+
54+
[![Release 📦](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/release.yml/badge.svg)](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/release.yml) [![Documentation 📚](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/documentation.yml/badge.svg)](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/documentation.yml)
55+
56+
```
57+
dotnet build -c Release
58+
```
59+
> [!NOTE]
60+
> This is a stub. More indepth build/testing guides will be available at some point.
61+
5262
## 😴 Licensing
5363
By submitting a PR, you are agreeing that your code is licensed under the same as defined in the accompying license file of the project. You transfer all rights to the code to the project and its community in perpetuity and retain authorship credit to the code.

Docfx/articles/getting_started/introduction.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,10 @@ The [DiscordRPC.Example](https://github.com/Lachee/discord-rpc-csharp/blob/maste
126126
dotnet run --framework net9 --project DiscordRPC.Example --example=Basic
127127
```
128128

129+
## Building
130+
131+
Check out the building guide in the [CONTRIBUTING.md](https://github.com/Lachee/discord-rpc-csharp/blob/master/CONTRIBUTING.md)
132+
129133
# Need More Help?
130134

131135
[![GitHub issues](https://img.shields.io/github/issues-raw/lachee/discord-rpc-csharp.svg?color=green&label=issues%20opened&logo=github)](https://github.com/Lachee/discord-rpc-csharp/issues)

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,6 @@ dotnet run --project DiscordRPC.Example
144144

145145
## Building
146146

147-
[![Release 📦](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/release.yml/badge.svg)](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/release.yml) [![Documentation 📚](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/documentation.yml/badge.svg)](https://github.com/Lachee/discord-rpc-csharp/actions/workflows/documentation.yml)
148-
149-
150-
**DiscordRPC Library**
151-
```
152-
dotnet build -c Release
153-
```
154-
155147
**Unity3D**
156148

157149
If you wish to have barebones Unity3D implementation, you need to build the `DiscordRPC.dll`, the [Unity Named Pipes](https://github.com/Lachee/unity-named-pipes) Library and the [UnityNamedPipe.cs](https://github.com/Lachee/discord-rpc-csharp/blob/master/Unity%20Example/Assets/Discord%20RPC/Scripts/Control/UnityNamedPipe.cs). Put these in your own Unity Project and the `.dll`s in a folder called `Plugins`.

0 commit comments

Comments
 (0)