Skip to content

Commit

Permalink
Add not about supported platforms
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanfrey committed Jan 15, 2020
1 parent 0b42314 commit eafe1d7
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit eafe1d7

Please sign in to comment.