diff options
author | Taeer Bar-Yam <taeer@bar-yam.me> | 2022-02-17 13:59:32 -0500 |
---|---|---|
committer | Taeer Bar-Yam <taeer@bar-yam.me> | 2022-02-17 13:59:32 -0500 |
commit | f56dd3a36bc8a325028588fd5500cbc33fa48a26 (patch) | |
tree | 695710479528dd14c84f06b1bd93d1ddc73f7f1a /src/nix/flake-init.md | |
parent | f3a2940e70dea2c35dcae3fca019e94bf8758b4d (diff) |
make flake template welcomeText markdown
Diffstat (limited to 'src/nix/flake-init.md')
-rw-r--r-- | src/nix/flake-init.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/nix/flake-init.md b/src/nix/flake-init.md index c8bcee375..c13b22248 100644 --- a/src/nix/flake-init.md +++ b/src/nix/flake-init.md @@ -37,8 +37,8 @@ A flake can declare templates through its `templates` and * `path`: The path of the directory to be copied. -* `welcomeText`: A block of text to display when a user initializes a new flake - based on this template. +* `welcomeText`: A block of markdown text to display when a user initializes a + new flake based on this template. Here is an example: @@ -50,8 +50,14 @@ outputs = { self }: { path = ./rust; description = "A simple Rust/Cargo project"; welcomeText = '' - You've created a simple Rust/Cargo template. - Visit https://www.rust-lang.org/ for more info. + # Simple Rust/Cargo Template + ## Intended usage + The intended usage of this flake is... + + ## More info + - [Rust language](https://www.rust-lang.org/) + - [Rust on the NixOS Wiki](https://nixos.wiki/wiki/Rust) + - ... ''; }; |