Merge pull request #6103 from Radvendii/welcomeText

add descriptive output when creating templates

1 files changed, 14 insertions, 0 deletions

diff --git a/src/nix/flake-init.md b/src/nix/flake-init.md
index 890038016..c13b22248 100644
--- a/src/nix/flake-init.md
+++ b/src/nix/flake-init.md
@@ -37,6 +37,10 @@ A flake can declare templates through its `templates` and
 
 * `path`: The path of the directory to be copied.
 
+* `welcomeText`: A block of markdown text to display when a user initializes a
+  new flake based on this template.
+
+
 Here is an example:
 
 ```
@@ -45,6 +49,16 @@ outputs = { self }: {
   templates.rust = {
     path = ./rust;
     description = "A simple Rust/Cargo project";
+    welcomeText = ''
+      # 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)
+      - ...
+    '';
   };
 
   templates.defaultTemplate = self.templates.rust;