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

Installation documentation #57 #86

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

RyanHiltyAllegheny
Copy link
Collaborator

What is the current behavior?

What is the new behavior if this PR is merged?

Small changes to the readme file adding additional detail for the user to have a streamline implementation

Type of change

Please describe the pull request as one of the following:

  • Bug fix
  • Breaking change
  • New feature
  • Documentation update
  • Other

Other information

This PR has:

  • Commit messages that are correctly formatted
  • Tests for newly introduced code
  • Docstrings for newly introduced code

Developers

@RyanHiltyAllegheny @WesleyL30 @GabeSchwartz @Thompsonn2

@codecov
Copy link

codecov bot commented Apr 12, 2021

Codecov Report

Merging #86 (c9ff688) into master (244b0ba) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #86   +/-   ##
=======================================
  Coverage   92.09%   92.09%           
=======================================
  Files           6        6           
  Lines         253      253           
=======================================
  Hits          233      233           
  Misses         20       20           

Copy link
Contributor

@enpuyou enpuyou left a comment

Choose a reason for hiding this comment

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

Thanks for the update in README. I think this is necessary! Just a minor note: why not just make this a requirement in the README. Sort of at the top of the installation instruction, note what OS and Python versions are supported.

@enpuyou
Copy link
Contributor

enpuyou commented Apr 14, 2021

Thanks for the update in README. I think this is necessary! Just a minor note: why not just make this a requirement in the README. Sort of at the top of the installation instruction, note what OS and Python versions are supported.

After #87 is passed, we should also be able to list Windows as a supported OS in the README.

@corlettim
Copy link
Collaborator

Please update your branch/PR with master

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.

7 participants