diff --git a/copier.yaml b/copier.yaml index 7bcd79b..1014be4 100644 --- a/copier.yaml +++ b/copier.yaml @@ -11,21 +11,29 @@ _message_after_copy: | Your project "{{ package_name }}" has been created successfully! - Next steps: + See the [guide](https://template-python-package.seedcase-project.org/docs/guide) for more detail + on the next steps. Briefly: 1. Change directory to the project root: - $ cd {{ _copier_conf.dst_path }} + ``` bash + cd {{ _copier_conf.dst_path | realpath }} + ``` - 2. Install the pre-commit hooks: + 2. Install the pre-commit hooks, add (called "update" here) the Quarto extension, + and build the README: - $ just install-precommit + ``` bash + just install-precommit update-quarto-theme build-readme + ``` - 3. Install [`spaid`](https://github.com/seedcase-project/spaid) and run these commands to upload and configure your project on GitHub: + 3. Install [`spaid`](https://github.com/seedcase-project/spaid) and run these setup steps: - $ spaid_gh_create_repo_from_local -h - $ spaid_gh_set_repo_settings -h - $ spaid_gh_ruleset_basic_protect_main -h + ``` bash + spaid_gh_create_repo_from_local -h + spaid_gh_set_repo_settings -h + spaid_gh_ruleset_basic_protect_main -h + ``` 4. Configure GitHub following this [guide](https://guidebook.seedcase-project.org/operations/security#using-github-apps-to-generate-tokens): @@ -37,7 +45,9 @@ _message_after_copy: | 5. List and complete all TODO items in the repository: - $ just list-todos + ``` bash + just list-todos + ``` # Questions: package_github_repo: