From 60300acc988dafe02a990d452a97a8c98fdac608 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Mon, 8 Jul 2024 21:58:57 +0200 Subject: [PATCH] Add a preamble to the question with the link to the docs Closes #154 --- Project.toml | 1 + src/BestieTemplate.jl | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/Project.toml b/Project.toml index 5278b307..e587c3e3 100644 --- a/Project.toml +++ b/Project.toml @@ -5,6 +5,7 @@ version = "0.7.2" [deps] CondaPkg = "992eb4ea-22a4-4c89-a5bb-47a3300528ab" +Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a" PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d" TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76" UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" diff --git a/src/BestieTemplate.jl b/src/BestieTemplate.jl index b5dc97bf..cb3f1c7e 100644 --- a/src/BestieTemplate.jl +++ b/src/BestieTemplate.jl @@ -10,6 +10,7 @@ module BestieTemplate include("Copier.jl") +using Markdown: @md_str using TOML: TOML using YAML: YAML @@ -27,6 +28,27 @@ function _copy(src_path, dst_path, data; kwargs...) data["PackageName"] = package_name end end + + display(md"""Hi, **❤ Bestie ❤** here. + + Below you will find a few questions to configure your template. + First, some **required** questions will need to be filled. + Then, you will have the option of selecting + + - The _recommended_ options, which includes our current _best practices recommendations_; + - The _minimum_ options, which will answer _no_ to everything, but still give you what + we consider the minimum best practices you need to get started; or + - Answer every optional question. + + On any case, we suggest reading the **full guide**, and possibly other documentation pages: + + `https://abelsiqueira.com/BestieTemplate.jl/stable/10-full-guide` + + If something does not work as you would expect or you need clarifications, + please open an issue or discussion. + + **❤ Good luck filling the questions, and thanks for choosing BestieTemplate ❤** + """) Copier.copy(src_path, dst_path, data; kwargs...) end