Initial commit HEAD master

1 files changed, 35 insertions, 0 deletions

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..5a55778
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,35 @@
+# Rory&::MatrixContentFilter
+
+An extensible, proactive Matrix moderation bot
+
+Note: anything below this line still has to be updated :)
+
+# Running from source
+
+```sh
+git clone --recursive $REPO
+cd ModerationClient/ModerationClient
+dotnet run --property WarningLevel=0
+```
+
+# Contributing
+
+```sh
+# Prepare patch set
+mkdir patches
+git format-patch --output-directory "./patches" @{u}..
+
+# Send patches
+```
+
+### Developer utility commands
+
+Error reporting upon file save:
+```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
+```