Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a preamble to the question with the link to the docs #344

Merged
merged 1 commit into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
22 changes: 22 additions & 0 deletions src/BestieTemplate.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module BestieTemplate

include("Copier.jl")

using Markdown: @md_str
using TOML: TOML
using YAML: YAML

Expand All @@ -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

Expand Down
Loading