这是indexloc提供的服务，不要输入任何密码
Skip to content

chore: update README #10098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025
Merged

chore: update README #10098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion crates/turborepo-lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 1 addition & 10 deletions crates/turborepo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading