Update README to remove stale build instructions, mention C#

diff --git a/README.md b/README.md
index 4189b966803f4a606706771bb547673a7497e7ef..c8061f3c34f797fa8265e672f8d536a28a195788 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-LDK Java and TypeScript Bindings
-================================
+LDK Java, C#, and TypeScript Bindings
+=====================================
 
-This repo contains an autogeneration system to generate LDK bindings for garbage-collected languages, currently including Java and TypeScript. See below for the current status of the bindings.
+This repo contains an autogeneration system to generate LDK bindings for garbage-collected languages, currently including Java, C#, and TypeScript. See below for the current status of the bindings.
 
 The auto-generated code contains copies of the Rust documentation, which can also be viewed at
 [docs.rs/lightning](https://docs.rs/lightning). High-level documentation of the API can be found at
@@ -10,31 +10,13 @@ The auto-generated code contains copies of the Rust documentation, which can als
 Building
 ========
 
-A release build of the Java bindings library for Linux is available in git. Thus, the bindings should work as long as the `LD_LIBRARY_PATH` includes the top-level directory of this repository.
-
-To build the bindings locally, the bindings require some additional work which is still making its
-way upstream, for now it should be built against the
-[rust-lightning 2022-10-112-java-bindings branch on git.bitcoin.ninja](https://git.bitcoin.ninja/?p=rust-lightning;a=shortlog;h=refs/heads/2022-10-112-java-bindings).
-Check that branch out locally as well as [ldk-c-bindings](https://github.com/lightningdevkit/ldk-c-bindings)
-and run the `genbindings.sh` script in ldk-c-bindings to build the required binaries. Thereafter,
-in this repo, run the `genbindings.sh` script with the first argument pointing to the ldk-c-bindings
-directory, the second the relevant JNI CFLAGS, the third argument set to `true` or `false` to
-indicate whether building in debug mode, and the third set to true or false to indicate if the
-bindings should be built with workarounds required for Android. JNI CFLAGS on debian are likely
-"-I/usr/lib/jvm/java-11-openjdk-amd64/include/ -I/usr/lib/jvm/java-11-openjdk-amd64/include/linux/".
-When running a program linking against the library in debug mode, LD_PRELOAD should likely include
-the relevant `libclang_rt.asan-platform.so` path.
-
-Note that building with address sanitizer is only supported on MacOS with upstream clang (ie where
-the LLVM version in use matches the LLVM version against which rustc was built), not with Apple clang.
-Builds with Apple clang will work fine, but largely only be useful in a release context.
-To build on Mac with address sanitizer, you will need to run `ldk-c-bindings`' `genbindings.sh`
-script with upstream clang in your PATH and likely replace your $JAVA_HOME/bin/java with a simple
-wrapper which calls java after an export like:
-`export DYLD_INSERT_LIBRARIES=/path/to/upstream/llvm/lib/clang/12.0.0/lib/darwin/libclang_rt.asan_osx_dynamic.dylib`
-
-To build for Apple M1 (ie aarch64-apple-darwin), you probably want something like
-`CC="clang --target=aarch64-apple-darwin" LDK_TARGET=aarch64-apple-darwin LDK_TARGET_CPU=generic ./genbindings.sh ...`
+The releases for Java, C#, and TypeScript are all deterministic. You should be able to reproduce
+the release binaries identically by running the scripts run in CI, see
+[.github/workflows/build.yml](.github/workflows/build.yml).
+
+Releases for all platforma re built on Linux as that is the easiest way to get things
+deterministic, however building on macOS should also work. Building on Windows is not currently
+supported.
 
 Status
 ======