Add autogenerated basic content to README #116
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samcunliffe
approved these changes
Jul 25, 2023
| pip install git+https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.git | ||
| ``` | ||
|
|
||
| Alternatively create a local clone of the repository with |
There was a problem hiding this comment.
Do we want to get into the business of setting up a mamba(conda) environment?
It's one of our recommended dev tools.
There was a problem hiding this comment.
Good point - have added a bit of text saying we recommend installing in a virtual environment using a tool like Mamba or Conda with links to their docs - haven't included specific instructions of setting up an environment but hopefully links will be sufficient breadcrumb if people are not familiar how to do this already.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds some basic automatic templated content to the Prerequisites, Installation and Running Tests sections in the README.md based on the template variables. Not sure how useful this is.