-
Notifications
You must be signed in to change notification settings - Fork 0
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 readmes for all clients - move common things to one place. #113
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,70 @@ | ||
# Rust core | ||
|
||
## Prerequisites | ||
|
||
Please consider installing the following packages: | ||
|
||
- GCC | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess they didn't add all these to a common file because the idea was that people would prefer to look at the documentation of the specific client. (looking from a different perspective) Maybe, we should ask them if they prefer this before making the PR? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure, good idea |
||
- pkg-config | ||
- openssl | ||
- openssl-dev | ||
- rust | ||
- protoc (protobuf compiler) | ||
|
||
**Protoc installation** | ||
|
||
Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases/tag/v25.1) and make it accessible in your $PATH by moving it or creating a symlink. | ||
For example, on Linux you can copy it to `/usr/bin`: | ||
|
||
```bash | ||
sudo cp protoc /usr/bin/ | ||
``` | ||
|
||
Check that the protobuf compiler is installed: | ||
```bash | ||
protoc --version | ||
``` | ||
|
||
**Dependencies installation for Ubuntu** | ||
|
||
```bash | ||
sudo apt update -y | ||
sudo apt install -y libssl-dev openssl gcc curl pkg-config | ||
``` | ||
|
||
**Dependencies installation for MacOS** | ||
|
||
```bash | ||
brew update | ||
brew install gcc pkgconfig openssl curl | ||
``` | ||
|
||
**Dependencies installation for CentOS** | ||
|
||
```bash | ||
sudo yum update -y | ||
sudo yum install -y gcc pkgconfig openssl openssl-devel curl | ||
``` | ||
|
||
**Dependencies installation for Amazon Linux** | ||
|
||
```bash | ||
sudo yum update -y | ||
sudo yum install -y gcc pkgconfig openssl openssl-devel which curl redis6 gettext --allowerasing | ||
``` | ||
|
||
**Rust toolchain installation** | ||
|
||
```bash | ||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | ||
source "$HOME/.cargo/env" | ||
``` | ||
|
||
Check that the Rust compiler is installed: | ||
```bash | ||
rustc --version | ||
``` | ||
|
||
## Recommended VSCode extensions | ||
|
||
[rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - Rust language server. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove. It's very polite, but not needed for a prerequisite section. It makes it sound like the following packages are optional.