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.

Sign up for GitHub

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

Jump to bottom

Update Windows instructions in README.md #4184

Closed
wants to merge 4 commits into from
Closed

Update Windows instructions in README.md #4184

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
deb24b8
Johnjanreadme (#17)
thejohnjansen Nov 8, 2016
e6fdc7d
Add ECMAScript 6 Modules test cases
AtOMiCNebula Nov 10, 2016
360d873
Merge pull request #18 from AtOMiCNebula/jdweiner/es6modules-initial
thejohnjansen Nov 17, 2016
50a9973
Code review feedback
thejohnjansen Nov 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 24 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,14 @@ Running the Tests
=================

The tests are designed to be run from your local computer. The test
environment requires Python 2.7+ (but not Python 3.x). You will also
need a copy of OpenSSL. Users on Windows should read the
[Windows Notes](#windows-notes) section below.
environment requires [Python 2.7+](http://www.python.org/downloads) (but not Python 3.x).
Leave the default install settings so Python will be installed to the c:\python2x directory.

Be sure to add that directory to your `%Path%`
[Environment Variable](http://www.computerhope.com/issues/ch000549.htm).
Copy link
Contributor

Choose a reason for hiding this comment

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

The %Path% syntax is Windows-specific, right? And the http://www.computerhope.com/issues/ch000549.htm info is also Windows-specific. So it seems like this should be moved to that Windows Notes section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for that. I've moved that sentence to the Windows Notes section now.


You will also need a copy of OpenSSL.
Users on Windows should read the [Windows Notes](#windows-notes) section below.

To get the tests running, you need to set up the test domains in your
[`hosts` file](http://en.wikipedia.org/wiki/Hosts_%28file%29%23Location_in_the_file_system). The
Expand Down Expand Up @@ -80,18 +85,24 @@ Running wptserve with SSL enabled on Windows typically requires
installing an OpenSSL distribution.
[Shining Light](https://slproweb.com/products/Win32OpenSSL.html)
provide a convenient installer that is known to work, but requires a
little extra setup.
little extra setup, i.e.:

After installation ensure that the path to OpenSSL is on your `%Path%`
environment variable.
Run the installer for Win32_OpenSSL_v1.1.0b (30MB). During installation,
change the default location for where to Copy OpenSSL Dlls from the
System directory to the /bin directory.

Then set the path to the default OpenSSL configuration file (usually
something like `C:\OpenSSL-Win32\bin\openssl.cfg` in the server
configuration. To do this copy `config.default.json` in the
web-platform-tests root to `config.json`. Then edit the JSON so that
the key `ssl/openssl/base_conf_path` has a value that is the path to
the OpenSSL config file.
After installation, ensure that the path to OpenSSL (typically,
this will be `C:\OpenSSL-Win32\bin`) is in your `%Path%`
[Environment Variable](http://www.computerhope.com/issues/ch000549.htm).
If you forget to do this part, you will most likely see a 'File Not Found'
error when you start wptserve.

Finally, set the path value in the server configuration file to the
default OpenSSL configuration file location. To do this,
copy `config.default.json` in the web-platform-tests root to `config.json`.
Then edit the JSON so that the key `ssl/openssl/base_conf_path` has a
value that is the path to the OpenSSL config file (typically this
will be `C:\\OpenSSL-Win32\\bin\\openssl.cfg`).

Test Runner
===========
Expand Down Expand Up @@ -248,4 +259,4 @@ Documentation
=============

* [How to write and review tests](http://testthewebforward.org/docs/)
* [Documentation for the wptserve server](http://wptserve.readthedocs.org/en/latest/)
* [Documentation for the wptserve server](http://wptserve.readthedocs.org/en/latest/)