Skip to content
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

Updating Installation Instructions #211

Merged
merged 4 commits into from
Aug 7, 2024
Merged

Updating Installation Instructions #211

merged 4 commits into from
Aug 7, 2024

Conversation

AarynnCarter
Copy link
Collaborator

Quick PR to update the installation instructions on the readthedocs.

I have also removed the instructions from the README, along with the tracker of which modules were working. The argument being that a) having two sets of installation instructions is more difficult to keep updated, and b) the vast majority of the files under "code status" are working, and do not provide a significant amount of context beyond what the ReadTheDocs tutorials already show.

@AarynnCarter AarynnCarter requested review from kglidic and mperrin August 7, 2024 16:48
Copy link
Collaborator

@mperrin mperrin left a comment

Choose a reason for hiding this comment

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

A few small suggestions; see comments below.

Just to check and 100% sure: At this point there's no longer any need to install any special branch of pyKLIP?

README.rst Show resolved Hide resolved
docs/source/Installation-and-dependencies.rst Outdated Show resolved Hide resolved
@AarynnCarter
Copy link
Collaborator Author

@mperrin Changes made, ready for re-review

Copy link
Collaborator

@mperrin mperrin left a comment

Choose a reason for hiding this comment

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

👍

@AarynnCarter AarynnCarter merged commit 24d3d6e into develop Aug 7, 2024
4 checks passed
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.

2 participants