From 4879d78705c29ff5b46f7b085c0058ad21b2da69 Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Fri, 4 Jun 2021 21:56:14 -0400 Subject: [PATCH] Update the docs --- examples/migration/protractor/ReadMe.md | 4 ++-- help_docs/install.md | 14 +++++++++----- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/examples/migration/protractor/ReadMe.md b/examples/migration/protractor/ReadMe.md index 42f661bc..fd8f3e4e 100644 --- a/examples/migration/protractor/ReadMe.md +++ b/examples/migration/protractor/ReadMe.md @@ -10,9 +10,9 @@ $ pytest --rs -v --guest ========================== test session starts ========================== platform darwin -- Python 3.9.2, pytest-6.2.3, py-1.10.0, pluggy-0.13.1 -metadata: {'Python': '3.9.2', 'Platform': 'macOS-10.14.6-x86_64-i386-64bit', 'Packages': {'pytest': '6.2.3', 'py': '1.10.0', 'pluggy': '0.13.1'}, 'Plugins': {'html': '2.0.1', 'rerunfailures': '9.1.1', 'xdist': '2.2.1', 'metadata': '1.11.0', 'ordering': '0.6', 'forked': '1.3.0', 'seleniumbase': '1.62.0'}} +metadata: {'Python': '3.9.2', 'Platform': 'macOS-10.14.6-x86_64-i386-64bit', 'Packages': {'pytest': '6.2.4', 'py': '1.10.0', 'pluggy': '0.13.1'}, 'Plugins': {'html': '2.0.1', 'rerunfailures': '10.0', 'xdist': '2.2.1', 'metadata': '1.11.0', 'ordering': '0.6', 'forked': '1.3.0', 'seleniumbase': '1.63.10'}} rootdir: /Users/michael/github/SeleniumBase/examples, configfile: pytest.ini -plugins: html-2.0.1, rerunfailures-9.1.1, xdist-2.2.1, metadata-1.11.0, ordering-0.6, forked-1.3.0, seleniumbase-1.62.0 +plugins: html-2.0.1, rerunfailures-10.0, xdist-2.2.1, metadata-1.11.0, ordering-0.6, forked-1.3.0, seleniumbase-1.63.10 collected 4 items example_test.py::AngularJSHomePageTests::test_greet_user PASSED diff --git a/help_docs/install.md b/help_docs/install.md index 1fa205bf..9ac4ff58 100755 --- a/help_docs/install.md +++ b/help_docs/install.md @@ -2,31 +2,35 @@

Installation

-If installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use: +#### If installing SeleniumBase directly from [PyPI](https://pypi.python.org/pypi/seleniumbase), (the Python Package Index), use: + ```bash pip install seleniumbase ``` -If installing SeleniumBase from a Git clone, use: +#### If installing SeleniumBase from a Git clone, use: + ```bash git clone https://github.com/seleniumbase/SeleniumBase.git cd SeleniumBase/ pip install . ``` -For a development mode install in editable mode, use: +#### For a development mode install in editable mode, use: + ```bash git clone https://github.com/seleniumbase/SeleniumBase.git cd SeleniumBase/ pip install -e . ``` -If installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use: +#### If installing SeleniumBase from a [GitHub branch](https://github.com/seleniumbase/SeleniumBase), use: + ```bash pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase ``` -Useful ``pip`` options include: +#### Useful ``pip`` options include: * Add ``--upgrade`` OR ``-U`` to upgrade an installation. * Add ``--force-reinstall`` for a clean install.