-
Notifications
You must be signed in to change notification settings - Fork 12
Cleanup: readme file and a few more extra files that we don't need for "minimal mode" #105
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
Conversation
| Automation | | | ||
| | | | ||
|--------|--------| | ||
| Package | [](https://pypi.org/project/{{project_slug}}/) [](https://pypi.org/project/{{project_slug}}/) {% if use_rtd %}[](https://{{project_slug}}.readthedocs.io/en/latest/?badge=latest){% endif %} | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NOTE: Many of the badges in the README file are tied to PyPI, but our participants won't have a package there yet. So I made RTD render conditionally, but we might want to think about what badges we wish to include (maybe following the package guide?) and how we want to template them because a new project won't be on pypi yet.
*TODO: the above badges that indicate python version and package version will only work if your package is on PyPI. | ||
If you don't plan to publish to PyPI, you can remove them.* | ||
|
||
{{ project_name }} is a project that (describe what it does here). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe just {{ project_description }}
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure - i'll revert this to keep it simple!
Thank you for the speedy iterations @sneakers-the-rat !!! we've gotten a lot done on the template today. And things are working great in Codespaces. |
i am reaching for literally anything to avoid looking at this empty illustrator document that should have been a poster a week ago lmao |
Jonny, just start working on it :) Pretty please. 😆 Starting and filling that empty screen is the hardest part. |
ok merging this too!! |
No description provided.