about summary refs log tree commit diff
path: root/README.MD
diff options
context:
space:
mode:
Diffstat (limited to 'README.MD')
-rw-r--r--README.MD37
1 files changed, 7 insertions, 30 deletions
diff --git a/README.MD b/README.MD

index 31915d4..f5ede59 100644 --- a/README.MD +++ b/README.MD
@@ -1,41 +1,18 @@ # Rory&::LibMatrix An extensible C# library for the Matrix protocol. Primarily built around our own project needs, but we're open to contributions and improvements, especially around spec compliance. -The library currently targets .NET 8. We like to follow the latest release of .NET. +The library currently targets .NET 10. We like to follow the latest release of .NET. ArcaneLibs can be found on [GitHub](https://github.com/TheArcaneBrony/ArcaneLibs.git). Personally we use the [MatrixRoomUtils project](https://cgit.rory.gay/matrix/tools/MatrixRoomUtils.git/) as workspace, though improvements to make the library more easy to build outside of this would be appreciated. # Installation -Probably add as a submodule for now? NuGet packaging still has to be implemented. +You can find the packages under the RoryLibMatrix namespace on NuGet. +https://www.nuget.org/packages/RoryLibMatrix/ +https://www.nuget.org/packages/RoryLibMatrix.EventTypes/ +https://www.nuget.org/packages/RoryLibMatrix.Federation/ +https://www.nuget.org/packages/RoryLibMatrix.Utilities.Bot/ # Contributing -Any contribution is welcome, even if it's just documentation or recommended git practices! We're not too strict on code style, but we do have a few guidelines: -- Use spaces, not tabs -- Use 4 spaces for indentation -- Use the C# naming convention for variables, methods, etc. -- Wrap lines at 160 characters, though this value can be changed if it's too lean or strict -- Use the `#region` and `#endregion` directives to group code if you're adding utility functions - -```sh -# Prepare patch set -mkdir patches -git format-patch --output-directory "./patches" @{u}.. - -# Send patches -... -``` -You can send the patches to [@emma:rory.gay](https://matrix.to/#/@emma:rory.gay) or in the [Rory&::LibMatrix room](https://matrix.to/#/#libmatrix:rory.gay). - -### Developer utility commands - -Error reporting upon file save (may not work): -```sh -inotifywait -rmqe CLOSE_WRITE --include '.*\.cs$' . | while read l; do clear; dotnet build --property WarningLevel=0; done -``` - -Hot rebuild on file save: -```sh -dotnet watch run --no-hot-reload --property WarningLevel=0 -``` +See the [contributing guidelines](CONTRIBUTING.md) for more information.