about summary refs log tree commit diff
path: root/README.MD
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.MD34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..8a83d25
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,34 @@
+# Rory&::MatrixUtils
+
+Power tools for Matrix.
+
+# Installation
+
+```sh
+git clone --recursive $REPO
+cd MatrixUtils/MatrixUtils.Web
+dotnet publish
+cp -rv bin/Release/net8.0/publish/wwwroot /var/www/html_rmu
+```
+
+# 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
+```