Merge pull request #313 from stevemachacz/master

Updated docs

Author: mdmintz

help_docs/ReadMe.md

@@ -1,16 +1,16 @@
 ### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> SeleniumBase Help Documents
 
 > **Table of Contents / Navigation:**
-> - [**SeleniumBase Features List**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md)
-> - [**How SeleniumBase Works**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md)
-> - [**Webdriver Installation**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/webdriver_installation.md)
-> - [**Installing Python, Pip, & Git**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md)
-> - [**Python Virtual Env Tutorial**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md)
-> - [**Verify Webdriver Installation**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md)
-> - [**The Command Line Tutorial**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md)
-> - [**The Console Scripts Tutorial**](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md)
-> - [**SeleniumBase Method Summary**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md)
-> - [**MySQL Installation Overview**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md)
-> - [**Safari Driver Detailed Info**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md)
-> - [**Seeing Hidden Files on a Mac**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/hidden_files_info.md)
-> - [**SeleniumBase Case Studies**](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md)
+> - [**SeleniumBase Features List**](features_list.md)
+> - [**How SeleniumBase Works**](how_it_works.md)
+> - [**Webdriver Installation**](webdriver_installation.md)
+> - [**Installing Python, Pip, & Git**](install_python_pip_git.md)
+> - [**Python Virtual Env Tutorial**](virtualenv_instructions.md)
+> - [**Verify Webdriver Installation**](verify_webdriver.md)
+> - [**The Command Line Tutorial**](customizing_test_runs.md)
+> - [**The Console Scripts Tutorial**](/seleniumbase/console_scripts/ReadMe.md)
+> - [**SeleniumBase Method Summary**](method_summary.md)
+> - [**MySQL Installation Overview**](mysql_installation.md)
+> - [**Safari Driver Detailed Info**](using_safari_driver.md)
+> - [**Seeing Hidden Files on macOS**](hidden_files_info.md)
+> - [**SeleniumBase Case Studies**](happy_customers.md)

help_docs/features_list.md

@@ -4,7 +4,7 @@
 * Uses [Pytest](https://docs.pytest.org/en/latest/) and [Nose](http://nose.readthedocs.io/en/latest/) runners for test discovery, organization, execution, and logging.
 * Includes [console scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md) that save you time by installing web drivers automatically, etc. 
 * Includes a [website tour builder](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md) for creating and running walkthroughs on any website.
-* Works on multiple platforms such as Mac, Windows, Linux, and [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md).
+* Works on multiple platforms such as macOS, Windows, Linux, and [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md).
 * Uses a [flexible command-line interface](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) to customize & configure test runs.
 * Has Python libraries for helping you do much more with Selenium/WebDriver.
 * Has [Plugins](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/plugins) for logging data and screenshots automatically. ([Click to learn more](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md))

help_docs/hidden_files_info.md

@@ -1,6 +1,6 @@
-### Info about hidden files on a Mac
+### Info about hidden files on macOS
 
-Depending on your Mac settings, some files may be hidden from view in your Finder window, such as ``.gitignore``. To view all files, run the following command and then reopen the Finder window:
+Depending on your macOS settings, some files may be hidden from view in your Finder window, such as ``.gitignore``. To view all files, run the following command and then reopen the Finder window:
 ```bash
 defaults write com.apple.finder AppleShowAllFiles -bool true
 ```

help_docs/install_python_pip_git.md

@@ -2,17 +2,21 @@
 
 ### [Python 2.7 or 3.x](https://www.python.org/downloads/)
 
-If you're a MAC user, Python should already come preinstalled on your machine. You can use both Python 2.7 or Python 3.6+ with SeleniumBase. If you're on a MAC and have [Homebrew](https://brew.sh/) installed, you can use: ``brew install python3`` to install Python 3. Or you can just get everything from [https://www.python.org/downloads/](https://www.python.org/downloads/).
+#### macOS:
 
-For MAC, there's also the official docs.python-guide.org instructions here: [Installing Python 2 on Mac OS X](https://docs.python-guide.org/starting/install/osx/) and [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/#install3-osx).
+Python should already come preinstalled. You can use both Python 2.7 or Python 3.6+ with SeleniumBase. If you have [Homebrew](https://brew.sh/) installed, you can use: ``brew install python3`` to install Python 3. Or you can just get everything from [https://www.python.org/downloads/](https://www.python.org/downloads/).
 
-If you're a WINDOWS user, [download Python 2.7 from here](https://www.python.org/downloads/release/python-2713/) OR [download Python 3.6.6 from here](https://www.python.org/downloads/release/python-366/).
+The official docs.python-guide.org instructions here: [Installing Python 2 on Mac OS X](https://docs.python-guide.org/starting/install/osx/) and [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/#install3-osx). (NOTE: Apple has rebranded OS X as macOS but this has not been reflected in the official docs.python-guide.org instructions yet.)
+
+#### Windows:
+
+You can [download Python 2.7 from here](https://www.python.org/downloads/release/python-2713/) OR [download Python 3.6.6 from here](https://www.python.org/downloads/release/python-366/).
 
 ### [Pip](https://en.wikipedia.org/wiki/Pip_%28package_manager%29)
 
 You might already have pip and setuptools installed, but if you don't:
 
-On MAC / Windows / Linux, run the following command:
+On macOS / Windows / Linux, run the following command:
 ```bash
 python -m ensurepip --default-pip
 ```
@@ -30,7 +34,7 @@ yum -y install python-pip
 
 If you're having any trouble getting pip, you can [GET PIP HERE](https://pip.pypa.io/en/latest/installing/).
 
-When done, make sure the location of pip is on your path, which is `$PATH` for Mac/Linux. (On Windows, it's the System Variables `Path` within System Environment Variables. Ex: Add "C:/Python27/Scripts/" to the end of the `Path` variable.)
+When done, make sure the location of pip is on your path, which is `$PATH` for macOS/Linux. (On Windows, it's the System Variables `Path` within System Environment Variables. Ex: Add "C:/Python27/Scripts/" to the end of the `Path` variable.)
 
 You can also get pip (or fix pip) by using:
 ```bash
@@ -39,9 +43,9 @@ curl https://bootstrap.pypa.io/get-pip.py | python
 
 (If you get SSL errors while trying to install packages with pip, see [this Stackoverflow post](https://stackoverflow.com/questions/49768770/not-able-to-install-python-packages-ssl-tlsv1-alert-protocol-version), which tells you to run the above command.)
 
-### [Homebrew](http://brew.sh/) (MAC-ONLY) (OPTIONAL)
+### [Homebrew](http://brew.sh/) (macOS-ONLY) (OPTIONAL)
 
-The Homebrew package manager allows you to install things more easily on MacOS, such as Git and Chromedriver.
+The Homebrew package manager allows you to install things more easily on macOS, such as Git and Chromedriver.
 
 Here's the command line script to install Homebrew (*from [https://brew.sh/](https://brew.sh/)*):
 ```bash
@@ -56,7 +60,7 @@ brew update
 
 You can [download Git from here](http://git-scm.com/downloads).
 
-MAC-ONLY shortcut: (This step only works if you installed Homebrew in the previous step)
+macOS-ONLY shortcut: (This step only works if you installed Homebrew in the previous step)
 ```bash
 brew install git
 ```

help_docs/mysql_installation.md

@@ -5,12 +5,12 @@
 
 (NOTE: If you're using this test framework from a local development machine and don't plan on writing to a MySQL DB from your local test runs, you can skip this step.)
 
-Mac:
+##### macOS:
 ```bash
 brew install MySQL
 ```
 
-Windows:
+##### Windows:
 [Download MySQL here](http://dev.mysql.com/downloads/windows/)
 
 That installs the MySQL library so that you can use database commands in your code. To make that useful, you'll want to have a MySQL DB that you can connect to.

help_docs/using_safari_driver.md

@@ -1,6 +1,6 @@
-### Info about using Safari Driver for running automated tests on a MAC
+### Info about using Safari Driver for running automated tests on macOS
 
-(NOTE: SafariDriver requires Safari 10 running on OSX El Capitan or greater)
+(NOTE: SafariDriver requires Safari 10 running on OS X 10.11 El Capitan or greater)
 
 You can find info on Safari Driver if you scroll down to that section on the [SeleniumHQ downloads page](https://www.seleniumhq.org/download/).
 

help_docs/virtualenv_instructions.md

@@ -2,7 +2,7 @@
 
 ### **Step 1**: First install [VirtualEnv](http://virtualenv.readthedocs.org/en/latest/) and [VirtualEnvWrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) (<i>if not installed</i>):
 
-### MAC / Linux:
+#### macOS / Linux:
 
 (*Shortcut*: Run "``source virtualenv_install.sh``" from the top-level SeleniumBase folder to perform the following steps.)
 
@@ -13,9 +13,9 @@ source `which virtualenvwrapper.sh`
 export WORKON_HOME=$HOME/.virtualenvs
 ```
 
-If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~/.bash_profile`` on a Mac, or ``~/.bashrc`` on Linux), virtualenvwrapper commands such as ``mkvirtualenv`` will be available whenever you open a new command prompt.
+If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~/.bash_profile`` on macOS, or ``~/.bashrc`` on Linux), virtualenvwrapper commands such as ``mkvirtualenv`` will be available whenever you open a new command prompt.
 
-### WINDOWS:
+#### Windows:
 
 (*Shortcut*: Run "``virtualenv_install.bat``" from the top-level SeleniumBase folder to perform the following steps.)
 
@@ -26,7 +26,7 @@ python -m pip install --upgrade virtualenvwrapper-win
 
 ### **Step 2**: Now use VirtualEnv or VirtualEnvWrapper to create a virtual environment:
 
-### MAC / Linux / WINDOWS:
+#### macOS / Linux / Windows:
 
 ```bash
 mkvirtualenv seleniumbase

help_docs/webdriver_installation.md

@@ -11,7 +11,7 @@ seleniumbase install iedriver
 seleniumbase install operadriver
 ```
 
-If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for remote webdriver), you'll need to put the drivers on your System PATH. On a Mac and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
+If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for remote webdriver), you'll need to put the drivers on your System PATH. On macOS and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
 
 Here's where you can go to manually install web drivers from the source:
 
@@ -27,9 +27,9 @@ Here's where you can go to manually install web drivers from the source:
 
 * For PhantomJS headless browser automation, get [PhantomJS](http://phantomjs.org/download.html) on your System PATH. (NOTE: <i>PhantomJS is no longer officially supported by SeleniumHQ</i>)
 
-**Mac**:
+**macOS**:
 
-* On a Mac, you can also install drivers by using ``brew`` (aka ``homebrew``), but you'll need to install that first. [Brew installation instructions are here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md).
+* You can also install drivers by using ``brew`` (aka ``homebrew``), but you'll need to install that first. [Brew installation instructions are here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md).
 
 ```bash
 brew cask install chromedriver