Copy of README

README.md

@@ -46,6 +46,33 @@ Other directives:
 * `import <go pkg>` - includes an additional go importin the compiled lib.go (needed for experiments)
 * Functions that start with `Enhanced` are automatically stripped of that prefix for their binding names e.g. `EnhancedGetMessage` generated a binding `c_GetMessage` - for certain functions Cwtch has two potential calling options `<Function>` and `Enhanced<Function>`. "Enhanced" in this case means that the response is optimised for calling by a user-facing application by e.g. directly making a number of calls under the hood and returning a json blob of the results.
 
+# Using
+
+## General Environment Variables
+
+- `LOG_FILE` if defined will mean all go logging will go to a file instead of stdout
+- `LOG_LEVEL` if set to `debug` will cause debug logging to be included in log output
+- `CWTCH_PROFILE` if set to `1` will cause a memory profile to be written to `mem.prof` and all active goroutines
+  written to `stdout` when `DebugInfo()` is called.
+- `CWTCH_TAILS` is set to `true` will override the Tor configuration to allow Cwtch to work in a Tail-like environment.
+
+## Linux Desktop:
+
+- `LD_LIBRARY_PATH` set to point to `libCwtch.so`
+- or drop a symlink into `/usr/lib`
+
+## Android
+
+- copy `cwtch.aar` into `flutter_app/android/cwtch`
+
+## Windows
+
+- copy libCwtch.dll into the directory of the `.exe` using it
+
+## MacOS
+
+- copy libCwtch.x64.dylib and libCwtch.arm.dylib into the directory you are executing from
+
 ## Support Cwtch Development
 
 We couldn't do what we do without all the wonderful community support we get, from [one-off donations](https://openprivacy.ca/donate) to [recurring support via Patreon](https://www.patreon.com/openprivacy).