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

describing installation using pip #726

Merged
merged 1 commit into from
Aug 9, 2022
Merged

Conversation

sepastian
Copy link
Contributor

@sepastian sepastian commented Jun 13, 2022

Description

Describe installation using pip in README.rst.

Motivation and Context

The current section on installation describes how to clone pywb and build/install it locally.
This is complicated, it is enough to simply pip install pywb.

Screenshots (if appropriate):

Types of changes

  • Replay fix (fixes a replay specific issue)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added or updated tests to cover my changes.
  • All new and existing tests passed.


Note: depending on your Python installation, you may have to use `pip3` instead of `pip`.

To install, test and build docs locally you can:

* Install with ``python setup.py install``
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the indentation off here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure I see what you mean. It looks ok to me, the lines I inserted are flush with the left hand margin.

Copy link
Contributor

Choose a reason for hiding this comment

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

My apologies, it must have been how I was looking at the diff!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No worries, thanks for the merge - and all the useful tools!

@ikreymer ikreymer merged commit 7b00d06 into webrecorder:main Aug 9, 2022
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.

3 participants