diff --git a/transcrypt/docs/sphinx/installation_use.rst b/transcrypt/docs/sphinx/installation_use.rst index 0acb1406a..1f4283e57 100644 --- a/transcrypt/docs/sphinx/installation_use.rst +++ b/transcrypt/docs/sphinx/installation_use.rst @@ -4,7 +4,7 @@ Getting started Installation ------------ -Transcrypt is currently tested under Windows, Linux and OSX, with Chrome, Internet Explorer and Firefox. To be able to use it, Python 3.7 has to be installed. After that, install *virtualenv* as explained in `Jamie Matthews very clear and brief introduction `_. Be sure to install virtualenv for the right Python version, by using the right *pip*. For each Transcrypt project (or group of projects using the same Transcrypt version) create an environment as described in the referenced introduction. To install Trancrypt into that environment, *activate* the environment as also described there, and then type: +Transcrypt is currently tested under Windows, Linux and OSX, with Chrome, Internet Explorer and Firefox. To be able to use it, Python 3.7 has to be installed (Transcrypt will not work with any earlier versions, including the whole Python 3.6 series). After that, install *virtualenv* as explained in `Jamie Matthews very clear and brief introduction `_. Be sure to install virtualenv for the right Python version, by using the right *pip*. For each Transcrypt project (or group of projects using the same Transcrypt version) create an environment as described in the referenced introduction. To install Trancrypt into that environment, *activate* the environment as also described there, and then type: *pip install transcrypt* @@ -24,9 +24,9 @@ To enable minification, additionally the Java Runtime Environment 6 or later has You can test your installation as follows (replacing *transcrypt* by *run_transcrypt* if you installed manually rather than with pip): 1. Go to directory *../Transcrypt-/transcrypt/development/automated_tests/transcrypt* -2. From the command prompt run *transcrypt -b -c -da autotest*. This will compile the autotests into a number of .js files and put them into the *__target__* subdirectory. Do NOT go to that directory (there's no need, stay where you went at point 4) -3. From the command prompt run *transcrypt -r -c autotest*. This will run the autotests with CPython creating file *autotest.html* that refers to the generated *autotest.js* file -4. Start a http server from the command prompt by typing *python -m http.server*, or, dependent on your installation *python3 -m http.server*. In the address bar of your browser, type *localhost:8000/animals.html*. This will load the autotest, run it and compare the output with what was generated by CPython. It should report no errors +2. From the command prompt run *transcrypt -xr -n -b -da -xg -c -sf autotest*. This will compile the autotests into a number of .js files and put them into the *__target__* subdirectory. Do NOT go to that directory (there's no need, stay where you went at the previous bullet point) +3. From the command prompt run *transcrypt -r -xr -n -b -da -xg -c -sf autotest*. This will run the autotests with CPython creating file *autotest.html* that refers to the generated *autotest.js* file +4. Start a http server from the command prompt by typing *python -m http.server*, or, dependent on your installation *python3 -m http.server*. In the address bar of your browser, type *http://localhost:8000/autotest.html*. This will load the autotest, run it and compare the output with what was generated by CPython. It should show a table with the number of errors for each test case (which should be zero for all of them) and a summary Status field at the top which should say *Test succeeded* To experiment with Transcrypt yourself: