From 9239012d763baeda1898644f11df507a8a68f3c0 Mon Sep 17 00:00:00 2001 From: tomimor Date: Mon, 5 Aug 2024 17:43:04 -0300 Subject: [PATCH] windows-compatibility-readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ffc311d7..8141aa33f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository enhances Foundry to support zkSync Era, enabling Solidity-based > 🔧 **Fork Notice:** This is a Foundry fork with added zkSync support. > -> ⚠️ **Alpha Stage:** The project is in alpha, so you might encounter issues. +> ⚠️ **Alpha Stage:** The project is in alpha, so you might encounter issues. For more information, please review [Limitations](#limitations) section. > > 🐞 **Found an Issue?** Please report it to help us improve. @@ -59,6 +59,7 @@ While `foundry-zksync` is **alpha stage**, there are some limitations to be awar - **Contract Verification**: Currently contract verification via the `--verify` flag do not work as expected but will be added shortly. - **Specific Foundry Features**: Currently features such as `--gas-report`, `--coverage` may not work as intended. We are actively working on providing support for these feature types. - **Solc Compatibility**: `zksolc` requires a `solc` binary to be run as a child process. The version/path to use for each can be specified by the `zksolc` and `solc` options in `foundry.toml`. Not all `solc` versions are supported by all `zksolc` versions, compiling with a `solc` version higher than the one supported may lead to unexpected errors. [Read the docs](https://docs.zksync.io/zk-stack/components/compiler/toolchain/solidity.html#limitations) about version limitations and check the [zksolc changelog](https://github.com/matter-labs/era-compiler-solidity/blob/main/CHANGELOG.md) to see the latest supported `solc` version. +- **Windows Compatibility**: Windows is not officially supported yet. However, we will be adding support for Windows soon and will assist with reported issues as possible. For the most effective use of our library, we recommend familiarizing yourself with these features and limitations.