From b984cca345ce78d937c5d8d1b6e51f02f46f2fc8 Mon Sep 17 00:00:00 2001 From: pongo1231 Date: Mon, 12 Feb 2024 20:36:01 +0000 Subject: [PATCH] TwitchChatVotingProxy: Add README --- TwitchChatVotingProxy/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 TwitchChatVotingProxy/README.md diff --git a/TwitchChatVotingProxy/README.md b/TwitchChatVotingProxy/README.md new file mode 100644 index 000000000..e543566df --- /dev/null +++ b/TwitchChatVotingProxy/README.md @@ -0,0 +1,16 @@ +# ChaosMod TwitchChatVotingProxy Project + +This is where the source code for the voting process resides in. Contrary to the name it supports multiple platforms now: Twitch and Discord. + +## Building + +Either through Visual Studio or using the `dotnet` CLI tool (`dotnet build` or `dotnet publish`). + +## Coding conventions + +- This project provides a custom .editorconfig file. Please make sure to format your source code before contributing, there should be support for just about every IDE / editor out there - either officially or using an extension. Alternatively you can run `dotnet format`. +- Always use brackets for if, for and while expressions. +- Naming: + - Private member variables: `m_Foo` + - Static global variables specific to file: `ms_Foo` + - Global member: `Foo` \ No newline at end of file