Skip to content

Commit c181163

Browse files
committed
remove the skeleton from README.md
1 parent 14e089f commit c181163

1 file changed

Lines changed: 2 additions & 58 deletions

File tree

README.md

Lines changed: 2 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -77,65 +77,9 @@ Run `copier copy` with the template:
7777
copier copy https://github.com/nlesc/python-template.git path/to/destination
7878
```
7979

80-
#### Step 2/2: Read about what was just generated
81-
82-
Good job! You have now generated the skeleton for your package:
83-
84-
```text
85-
.
86-
├── CHANGELOG.md
87-
├── CITATION.cff
88-
├── CODE_OF_CONDUCT.md
89-
├── CONTRIBUTING.md
90-
├── .copier-answers.yml
91-
├── docs
92-
│   ├── conf.py
93-
│   ├── index.rst
94-
│   ├── make.bat
95-
│   ├── Makefile
96-
│   └── _templates
97-
│   └── .gitignore
98-
├── .editorconfig
99-
├── .githooks
100-
│   └── pre-commit
101-
├── .github
102-
│   ├── next_steps
103-
│   │   ├── 01_sonarcloud_integration.md
104-
│   │   ├── 02_citation.md
105-
│   │   ├── 03_readthedocs.md
106-
│   │   ├── 04_zenodo_integration.md
107-
│   │   └── 05_linting.md
108-
│   └── workflows
109-
│   ├── build.yml
110-
│   ├── cffconvert.yml
111-
│   ├── documentation.yml
112-
│   ├── markdown-link-check.yml
113-
│   ├── next_steps.yml
114-
│   └── sonarcloud.yml
115-
├── .gitignore
116-
├── MANIFEST.in
117-
├── .mlc-config.json
118-
├── next_steps.md
119-
├── NOTICE
120-
├── project_setup.md
121-
├── pyproject.toml
122-
├── README.dev.md
123-
├── README.md
124-
├── .readthedocs.yaml
125-
├── sonar-project.properties
126-
├── src
127-
│   └── my_python_package
128-
│   ├── __init__.py
129-
│   └── my_module.py
130-
├── tests
131-
│   ├── __init__.py
132-
│   ├── test_my_module.py
133-
│   ├── test_project.py
134-
│   └── test_values.py
135-
└── .zenodo.json
136-
```
80+
Good job! Based on the profile and selected features, a package will be created in `path/to/destination`.
13781

138-
For an explanation of what's there, read on in the [project_setup.md](template/project_setup.md.jinja) file.
82+
For an explanation of what's there, read on in the `project_setup.md` file.
13983

14084
### Scenario 2: Apply to pre-existing code
14185

0 commit comments

Comments
 (0)