Update README.md #223
Merged
Update README.md #223
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
README.md
Outdated
|
|
||
| ```shell | ||
| pip3 install -r requirements.txt | ||
| ``` |
There was a problem hiding this comment.
i would just do pip and people can work out pip3
There was a problem hiding this comment.
now its duplcated, so just have one install instruction
peterdudfield
requested changes
Nov 15, 2024
There was a problem hiding this comment.
Looks good @ADIMANV
Could you add the https://github.com/openclimatefix/ocf-template?tab=readme-ov-file#contributing-and-community
and the very last thing in the tempalte.
I would also add a develop section. You can say we can only run this when connected to OCF databases, but we hope to change this in the future. Also the how to run tests would be a good thing to add.
README.md
Outdated
| @@ -2,36 +2,52 @@ | |||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | |||
| [](#contributors-) | |||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | |||
| [](https://github.com/openclimatefix#how-easy-is-it-to-get-involved) | |||
There was a problem hiding this comment.
I think ti should be hard - thats what would put it as ont he main page
peterdudfield
approved these changes
Nov 15, 2024
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.
Pull Request
Description
updated readme.md
How Has This Been Tested?
checked it locally
Checklist: