Skip to content

Commit eb1f02c

Browse files
authored
Merge pull request #609 from NLeSC/556_next_steps
556-remove next_steps.md and show its content as a user message
2 parents 2272a1d + 24133d3 commit eb1f02c

File tree

3 files changed

+30
-54
lines changed

3 files changed

+30
-54
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
1818

1919
### Changed
20+
* next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)
2021
* Change the default profile to 'recommended' [#598](https://github.com/NLeSC/python-template/pull/598)
2122
* Updated the user documentation (README.md) of the template [#569](https://github.com/NLeSC/python-template/pull/569)
2223
* Droped Python 3.8 and 3.9 support [#551](https://github.com/NLeSC/python-template/pull/551)

copier/messages.yml

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,39 @@ _message_before_copy: |
99
input to each of them.
1010
1111
_message_after_copy: |
12-
Your project "{{ package_name }}" has been created successfully!
12+
Your project "{{ package_name }}" has been successfully created in {{ _copier_conf.dst_path }} folder!
1313
14-
Next steps:
14+
{% if template_profile != 'minimum' -%}
1515
16-
1. Change directory to the project root:
16+
Next steps:
1717
18-
$ cd {{ _copier_conf.dst_path }}
18+
- Below are the commands to put your Python package under using git:
1919
20-
2. Read next_steps.md which contains information on next steps.
20+
cd {{ _copier_conf.dst_path }}
21+
git init
22+
git add --all
23+
git commit -m "first commit"
24+
git branch -M main
25+
git remote add origin {{ repository }}
26+
27+
- Push the initial commit to a new repo on GitHub
28+
29+
Go to https://github.com/organizations/{{github_organization}}/repositories/new
30+
and create a new repository named `{{ package_name }}` as an empty repository, then push your commits to GitHub:
31+
32+
git push --set-upstream origin main
33+
34+
{% if AddDevDoc -%}
35+
- Project development documentation
36+
37+
The README.dev.md contains developer documentation
38+
{%- endif %}
39+
40+
- Project layout explained
41+
42+
For an explanation of what files are there, and what each of these do, please refer to {{ _copier_conf.dst_path }}/project_setup.md
43+
44+
{%- endif-%}
2145
2246
_message_before_update: |
2347
Thanks for updating your project using our template.

template/next_steps.md.jinja

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)