Skip to content

New features#14

Open
jvanderleeuw wants to merge 39 commits into
developfrom
new_features
Open

New features#14
jvanderleeuw wants to merge 39 commits into
developfrom
new_features

Conversation

@jvanderleeuw
Copy link
Copy Markdown
Contributor

The changes made included adding README.md generation and Cookiecutter capabilities, and a jupyter notebook.

README generation takes place through https://github.com/andreasbm/readme . The process is that there is an original README.md that the user receives when they clone/download the repo for template-rgb-plot in general. After the user edits the cookiecutter.json file, they can generate a new README.md in a project folder that will ultimately stand on its own once the user creates their own project. This one will be personalized based on the metadata included in the Cookiecutter.json file.

After the user is finished creating their project, they can use Cookiecutter in order to make the folder originally titled {{ Cookiecutter._project_name }} a repository of its own

A jupyter notebook was also added and is accessible through this link. It may not be completely up to date yet but should be soon.

Comment thread .github/workflows/pylint_check.yaml Outdated
Comment thread blueprint.md Outdated
Comment thread blueprint.md Outdated
Comment thread blueprint.md Outdated
Comment thread blueprint.md Outdated
Comment thread blueprint.md
@Chris-Schnaufer
Copy link
Copy Markdown
Member

Can there be a GitHub action that checks the cookiecutter stuff?

@Chris-Schnaufer
Copy link
Copy Markdown
Member

Much more information on how to use the cookie cutter approach is needed in the README. I would have no idea as to what should be done if I didn't know about cookie cutter. Also add information on what can be done if someone is not using cookie cutter. Finally, the Jupyter Notebook should be removed from here (see draft PR #13)

Comment thread blueprint.md Outdated
Comment thread {{cookiecutter._project_name}}/generate.py Outdated
Comment thread {{cookiecutter._project_name}}/generate.py Outdated
Comment thread {{cookiecutter._project_name}}/generate.py Outdated
Comment thread {{cookiecutter._project_name}}/generate.py Outdated
@dlebauer
Copy link
Copy Markdown
Contributor

dlebauer commented May 4, 2025

@Chris-Schnaufer merge or close?

Copy link
Copy Markdown
Contributor

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Jacob! Only sorry this has taken so long. I'm no longer working on this repository; will defer to @Chris-Schnaufer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants