diff --git a/crates/turborepo-lib/README.md b/crates/turborepo-lib/README.md index 10ec2d56f0ec6..e9047ee641bc9 100644 --- a/crates/turborepo-lib/README.md +++ b/crates/turborepo-lib/README.md @@ -1,4 +1,7 @@ # turborepo-lib This crate contains most of the logic for the Turborepo binary and should only be consumed by the `turbo` crate. -The `turbo` crate handles building the CGO archive and linking it to the Rust code. These crates were split up so that we do not have to build the Go code to run the Rust tests. + +During the Go to Rust migration, we put most of the Turborepo logic in this crate, and left `turbo` as a thin wrapper +that built the Go code. That way, we could build all of our Rust code without triggering a Go build as well. +Since the migration is done, there's no real reason to keep this split, but we haven't removed it yet. diff --git a/crates/turborepo/README.md b/crates/turborepo/README.md index 378aec0222e68..515d8a86621b4 100644 --- a/crates/turborepo/README.md +++ b/crates/turborepo/README.md @@ -1,12 +1,3 @@ # turbo cli -## Build Requirement - -1. Install `protobuf` and `golang` (note: Go must be pinned to v1.20.x, see https://github.com/vercel/turborepo/issues/5918 for details) - -- On macOS: `brew install protobuf protoc-gen-go protoc-gen-go-grpc go@1.20 capnp` -- On Windows: `choco install golang --version=1.20.7` and `choco install protoc make python3 mingw` -- On Ubuntu: `apt-get install golang golang-goprotobuf-dev` - -2. `go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0` -3. `go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0` +A thin wrapper around `turborepo-lib`, which actually contains the main logic for Turborepo.