diff options
| author | Rory& <root@rory.gay> | 2024-02-23 12:30:39 +0100 |
|---|---|---|
| committer | Rory& <root@rory.gay> | 2024-02-23 12:30:39 +0100 |
| commit | 4f9311ed047c6e6a62e3d49be330a83a829b72fb (patch) | |
| tree | 86aaafacb1758351e515619b0a29aced378488db /README.MD | |
| parent | MessageBuilder extensions (diff) | |
| download | LibMatrix.ExampleBot-master.tar.xz | |
Add gitignore, license, editorconfig HEAD github/master master
Diffstat (limited to 'README.MD')
| -rw-r--r-- | README.MD | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..b0370b4 --- /dev/null +++ b/README.MD @@ -0,0 +1,41 @@ +# 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 primarily targets .NET 7, but will update to .NET 8 once that's released. Preferably, 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://git.rory.gay/matrix/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. + +# 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 +``` |