Projects/muscl
12
4
Fork 0
Code Issues 69 Pull Requests Actions Packages Releases Activity

Improve documentation
All checks were successful
Build and test / build (push) Successful in 2m41s
Details
Build and test / check (push) Successful in 1m46s
Details
Build and test / check-license (push) Successful in 58s
Details
Build and test / test (push) Successful in 3m7s
Details
Build and test / docs (push) Successful in 5m40s
Details

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2025-12-18 02:08:20 +09:00
parent 1f78ca0e25
commit 186adefc22
7 changed files with 91 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/compiling.md
View File

@@ -4,7 +4,8 @@ This document describes how to compile `muscl` from source code, along with othe
## Build
To just compile muscl, there is not many special steps needed. You need to have a working Rust toolchain installed.
To just compile `muscl`, there is not many special steps needed.
You need to have a working [Rust toolchain](https://www.rust-lang.org/tools/install) installed.
```bash
# Compile in debug mode
@@ -25,7 +26,7 @@ ls target/release-lto # muscl, mysql-dbadm, mysql-useradm, ...
> [!NOTE]
> This happens automatically when building the deb package, so you can skip this step if that's the goal.
In order to generate shell completions that work correctly, you want to put `muscl` (or alias symlinks) in your `$PATH`.
In order to generate shell completions that work correctly, you need to put `muscl` (or alias symlinks) in your `$PATH`.
```bash
cargo build --release