Skip to content
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.

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

Update README.md with building instructions #49

Closed
wants to merge 1 commit into from

Conversation

jbjorkang
Copy link
Member

@jbjorkang jbjorkang commented Oct 26, 2023

This change is Reviewable

@jbjorkang jbjorkang added the documentation Improvements or additions to documentation label Oct 26, 2023
@jbjorkang jbjorkang requested a review from faern October 26, 2023 08:38
@jbjorkang jbjorkang self-assigned this Oct 26, 2023
@jbjorkang
Copy link
Member Author

Missing URL for Rustup


Install Rust by following the guides for [Rustup]([url](https://www.rust-lang.org/tools/install))

Install ibc6-dev with APT:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo on package name. Missing l


```
$ ls target/x86_64-unknown-linux-gnu/release/
build deps examples incremental tcp2udp tcp2udp.d udp2tcp udp2tcp.d
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You only care about a single file here. I'm not going to mark this as a blocker, do whatever fits you. But if the main problem was to make it easy for someone not super into Rust to just produce a tcp2udp from this I would word it as:

Run the script build-static-bins.sh to produce the static binaries. The result will be available at target/x86_64-unknown-linux-gnu/release/tcp2udp

No one runs this script to get udp2tcp so we can ignore talking about that one.

@jbjorkang jbjorkang closed this Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants