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

rename project_setup.md #206

Open
jspaaks opened this issue Apr 21, 2021 · 3 comments
Open

rename project_setup.md #206

jspaaks opened this issue Apr 21, 2021 · 3 comments
Labels
documentation generated-package Related to the generated package, i.e. after running cookiecutter

Comments

@jspaaks
Copy link

jspaaks commented Apr 21, 2021

project_setup is not very clear to me, it seems to indicate something about how to set up a project, which at the time users learn about this file, they actually just did so they're not interested anymore. Of course it helps that we now point to this file from the posthook, but I feel the file name could be clearer as well.

I don't have any great alternatives, but here's a couple candidates:

  1. after_project_generation.md
  2. about_project_layout.md
  3. project_layout_explained.md

Out of these, I think I prefer 3, unless others have better suggestions?

@jspaaks jspaaks added the generated-package Related to the generated package, i.e. after running cookiecutter label Apr 21, 2021
@jspaaks
Copy link
Author

jspaaks commented Apr 21, 2021

Also, we could consider prepending whatever name we choose with README, e.g. README.project_layout_explained.md such that the file is listed next to README.md and README.dev.md

@jspaaks
Copy link
Author

jspaaks commented May 4, 2021

Absent suggestions, made PR #294

@egpbos
Copy link
Member

egpbos commented Feb 19, 2022

I think the file should be removed from the generated project altogether, see #310.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation generated-package Related to the generated package, i.e. after running cookiecutter
Projects
None yet
Development

No branches or pull requests

3 participants