diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 20 insertions, 5 deletions
@@ -10,12 +10,27 @@ It's a shell written in Rust. ### Sounds dumb, how do I use it? -You build it yourself. Clone the repository, and run - cargo build +Building with the default toolchain and target is simple: +```sh +cargo build +``` -To build the manpages you need scdoc: - scdoc < man/rs.1.scd > rs.1 - scdoc < man/rs.5.scd > rs.5 +You can also use musl instead of glibc. If this is not your default toolchain, +you can use rustup to install that target: +```sh +rustup target add x86_64-unknown-linux-musl +cargo build --target x86_64-unknown-linux-musl +``` + +Release builds look like: +```sh +cargo build --release --locked --all-features --target-dir=target +``` +where: + - --release tells cargo to compile a release build + - --locked tells cargo to adhere the Cargo.lock file and prevent it from updating dependencies which is important for reproducible builds. + - --all-features tells cargo to compile with all features of the package enabled. Alternatively, use --features FEATURE1,FEATURE2 if you want enable only selected features. + - --target-dir=target tells cargo to put the target directory in the current directory. ### It doesn't work, what now? |