From eafe1d77822af08e3e7805f3eb4e658d66748027 Mon Sep 17 00:00:00 2001 From: Ethan Frey Date: Thu, 16 Jan 2020 00:10:17 +0100 Subject: [PATCH] Add not about supported platforms --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1f84dba6d..f75f9e713 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,16 @@ involves compiling rust -> C library, and linking that library to the Go code. For ergonomics of the user, we will include pre-compiled libraries to easily link with, and Go developers should just be able to import this directly. +## Supported Platforms + +Since this package includes a rust prebuilt dll, you cannot just import the go code, +but need to be on a system that works with an existing dll. Currently this is Linux +(tested on Ubuntu, Debian, and CentOS7) and MacOS. We have a build system for Windows, +but it is not supported by the wasmer singlepass backend which we rely upon for gas +metering. + +*Note: Windows is not supported currently* + ## Design Please read the [Documentation](./spec/Index.md) to understand both the general