From eae79920831fa1a3a9bf26e97ec6d4202df2a7a9 Mon Sep 17 00:00:00 2001 From: zerosnacks <95942363+zerosnacks@users.noreply.github.com> Date: Mon, 20 Apr 2026 15:09:13 +0200 Subject: [PATCH] Revise README for foundry-compilers archiving Updated README to reflect the archiving of foundry-compilers and its maintenance under foundry-core. --- README.md | 67 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index ea739d11b..fafbb32f0 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,3 @@ -# Foundry Compilers +# foundry-compilers -| [Docs](https://docs.rs/foundry-compilers/latest/foundry_compilers/) | - -Originally part of [`ethers-rs`] as `ethers-solc`, Foundry Compilers is the compilation backend for [Foundry](https://github.com/foundry-rs/foundry). - -[`ethers-rs`]'s `ethers-solc` is considered to be in maintenance mode, and any fixes to it will also be reflected on Foundry Compilers. No action is currently needed from devs, although we heavily recommend using Foundry Compilers instead of `ethers-solc`. - -[`ethers-rs`]: https://github.com/gakonst/ethers-rs - -[![Build Status][actions-badge]][actions-url] -[![Telegram chat][telegram-badge]][telegram-url] - -[actions-badge]: https://img.shields.io/github/actions/workflow/status/foundry-rs/compilers/ci.yml?branch=main&style=for-the-badge -[actions-url]: https://github.com/foundry-rs/compilers/actions?query=branch%3Amain -[telegram-badge]: https://img.shields.io/endpoint?color=neon&style=for-the-badge&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Ffoundry_rs -[telegram-url]: https://t.me/foundry_rs - -## Supported Rust Versions - - - -The current MSRV (minimum supported rust version) is 1.88. - -Note that the MSRV is not increased automatically, and only as part of a minor -release. - -## Contributing - -Thanks for your help in improving the project! We are so happy to have you! We have -[a contributing guide](./CONTRIBUTING.md) to help you get involved in the -Foundry Compilers project. - -Pull requests will not be merged unless CI passes, so please ensure that your -contribution follows the linting rules and passes clippy. - -## Overview - -To install, simply add `foundry-compilers` to your cargo dependencies. - -```toml -[dependencies] -foundry-compilers = "0.19.14" -``` - -Example usage: - -```rust,ignore -use foundry_compilers::{Project, ProjectPathsConfig}; -use std::path::Path; - -// configure the project with all its paths, solc, cache etc. -let project = Project::builder() - .paths(ProjectPathsConfig::hardhat(Path::new(env!("CARGO_MANIFEST_DIR"))).unwrap()) - .build(Default::default()) - .unwrap(); -let output = project.compile().unwrap(); - -// Tell Cargo that if a source file changes, to rerun this build script. -project.rerun_if_sources_changed(); -``` +Archived as a standalone repository. Maintenance and publishing continue from [`foundry-core`](https://github.com/foundry-rs/foundry-core) under the same [`foundry-compilers`](https://crates.io/crates/foundry-compilers) crate name.