Skip to content

docs: update installation steps - #366

Open
aryanxk02 wants to merge 1 commit into
openclimatefix:mainfrom
aryanxk02:docs
Open

docs: update installation steps#366
aryanxk02 wants to merge 1 commit into
openclimatefix:mainfrom
aryanxk02:docs

Conversation

@aryanxk02

Copy link
Copy Markdown

Pull Request

Description

This PR updates the installation instructions in the README.md.

  1. Fix Missing requirements.txt reference: The README currently instructs to install dependencies via requirements.txt. Updated instructions to direct users to use pip install -e . instead.

Fixes #365

How Has This Been Tested?

The setup is verified locally in a fresh Python 3.11 virtual environment.

  • Yes

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

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.

Docs: README references missing requirements.txt file

1 participant