docs: create simple usage instructions #11
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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)
@krauterbaquette I reviewed and added a commit. Can you review my commit? LGTM if you are fine with my commit
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` |nice find
@ -12,7 +12,7 @@extraDescription ? "",extraPackages ? [ ],extraShellHook ? "",base ? "base",base ? "nativeBase",good fix :)