docs: create simple usage instructions #11

Merged
krauterbaquette merged 2 commits from docs into main 2025-12-27 23:17:54 +00:00

currently there are some parts left open but I think this is
a good starting point for someone who wants to use this wrapper.

Because we started to use this wrapper across all sort of projects of the solarpunk kollektiv dd
I think it is not that far fetched that someone else might have to deal with this software in the future
(e.g. me xD)

currently there are some parts left open but I think this is a good starting point for someone who wants to use this wrapper. Because we started to use this wrapper across all sort of projects of [the solarpunk kollektiv dd](https://git.solarpunk.social/solarpunk-kollektiv-dd) I think it is not that far fetched that someone else might have to deal with this software in the future (e.g. me xD)
currently there are some parts left open but I think this is
a good starting point for someone who wants to use this wrapper.
docs: small addition and filling gaps
Some checks failed
update-flake.yml / Merge pull request 'docs: create simple usage instructions' (#11) from docs into main (pull_request) Failing after 0s
c882418baa
aviac approved these changes 2025-12-23 06:12:59 +00:00
aviac left a comment
Owner

@krauterbaquette I reviewed and added a commit. Can you review my commit? LGTM if you are fine with my commit

@krauterbaquette I reviewed and added a commit. Can you review my commit? LGTM if you are fine with my commit
krauterbaquette left a comment
Author
Owner

lrgtm (looks really good to me)

lrgtm (looks really good to me)
@ -0,0 +35,20 @@
You can use [`nix-rust.lib.shell.mkRustShell`](./nix/lib/shell.nix) to create a rust devShell.
```nix
# flake.nix
{
outputs.devShells.default."x86_64-linux" = rust-nix.shell.mkRustShell {
system = "x86_64-linux";
base = "nativeWithOpenssl";
};
}
```
| Option | Description | Default |
|--------|-------------|---------|
| system | nixpkgs system for this devShell | `"x86_64-linux"` |
| extraDescription | additionaly devShell description | `""` |
| extraPackages | additionaly packages accessibly in the devShell (besides the rust toolchain) | `[]` |
| extraShellHook | bash code to execute on shell-enter | `""` |
| base | The base devShell to use. These are a combination of two parts "<toolchain><tooling>", where `toolchain` is one of `native,android,wasm` and `tooling` is one of `Base,WithOpenssl,BevyX11,BevyWayland`. Note that not every combination necessarily makes sense. | `"nativeBase"` |
| name | Name of the devShell. If set to null, the default devShell name will be used | `null` |
| extraRpathPackages | Packages that should be available as libaries to rust | `extraPackages` |
Author
Owner

nice find

nice find
@ -12,7 +12,7 @@
extraDescription ? "",
extraPackages ? [ ],
extraShellHook ? "",
base ? "base",
base ? "nativeBase",
Author
Owner

good fix :)

good fix :)
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
solarpunk-kollektiv-dd/nix-rust!11
No description provided.