diff --git a/rust/README.md b/rust/README.md index 2622bba2..61b0af80 100644 --- a/rust/README.md +++ b/rust/README.md @@ -7,21 +7,21 @@ https://www.rust-lang.org/learn/get-started ## Building rust code ### s390-tools build system If `cargo` is installed a simple `make` should do the job. Note that, -compiling rust programs take significaltly longer than C code. To closely -monitor the prgress use `make V=1` By default release builds are made. +compiling rust programs take significantly longer than C code. To closely +monitor the progress use `make V=1` By default release builds are made. With `make CARGOFLAGS=` one can pass additional flags to cargo. With `make HAVE_CARGO=0` one can turn of any compilation that requires cargo. With `make CARGO=<...>` one can set the cargo binary ### cargo -If you need to run cargo directly, cd to each project you want to build and +If you need to run cargo directly, `cd` to each project you want to build and issue your cargo commands. Do **NOT** forget to specify `--release` if you are building tools for a release. The s390-tools expect the environment variable `S390_TOOLS_RELEASE` to be present at build time. This is the version string the rust tools provide. -Tpp: You can use `make version` to get the version string. +Tip: You can use `make version` to get the version string. ## Internal Libraries * __utils__ _Library for rust tools that bundles common stuff for the 390-tools_ @@ -43,7 +43,7 @@ Exiting tools may be rewritten in Rust. ### What (third-party) crates can be used for s390-tools? A huge list of libraries are made available through Rusts' ecosystem and is one -of many upsides. However, just like with Coding Style Guidlines, it is +of many upsides. However, just like with Coding Style Guidelines, it is important to limit the usage of those libraries so that within a project, everyone is on the same page and that code written in Rust uses similar approaches. It makes it easier for code review and maintainability in general. @@ -98,8 +98,8 @@ use utils::release_string; fn print_version() { println!( "{} version {}\nCopyright IBM Corp. 2023", - env!("CARGO_PKG_NAME"), // collapes into the crates name - release_string!() // this (very likely) collapes into a compile time constant + env!("CARGO_PKG_NAME"), // collapses into the crates name + release_string!() // this (very likely) collapses into a compile time constant ); } ```