Skip to content

Commit 1fdb52d

Browse files
committed
update README to suggest Python-3.8.3, and to use the master branch
1 parent 28a4931 commit 1fdb52d

File tree

1 file changed

+14
-33
lines changed

1 file changed

+14
-33
lines changed

README.md

Lines changed: 14 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Unzip the GlowScriptOffline package to any convenient place on your computer.
3434

3535
Inside the [GlowScriptOffline](GlowScriptOffline) folder, read the README file to learn how to use the package.
3636

37-
Run a Local Server (Py3 version)
37+
Run a Local Server
3838
------------------
3939
There are two sets of instructions given here for two possible
4040
approaches.
@@ -45,28 +45,22 @@ If you're using macOS or Linux you can run the
4545
local webserver and datastore all in Docker. You don't need to install
4646
anything else. However there is a rather annoying
4747
bug in Windows that prevents the webserver from automatically restarting when
48-
source files change. For this reason, if they wish to have this feature,
49-
windows users must run a python process concurrently that tracks file
50-
changes during development. Having said that, if you just want to try a
51-
local webserver, and you don't care about having to restart the server
52-
manually every time you change the source code, you can skip running
53-
the extra python process. This is all described below.
54-
55-
2. The second, "Only Datastore in Docker", requires that users also install a
56-
recent (e.g., 3.7+) version of python (and pip) such as that provided by
48+
source files change. If you just want to try a local webserver, and you don't
49+
care about having to restart the server manually every time you change the
50+
source code, you can skip running the extra python process.
51+
52+
2. The second, "Only Datastore in Docker", requires that users install
53+
Python-3.8 such as that provided by
5754
[anaconda](https://docs.anaconda.com/anaconda/install/)
5855
(or [miniconda](https://docs.conda.io/en/latest/miniconda.html)), as well as
59-
[Docker](https://www.docker.com/products/docker-desktop). This is all also described below.
56+
[Docker](https://www.docker.com/products/docker-desktop).
6057

6158
### Local Server Approach (1) All Docker
6259

63-
First install [Docker](https://www.docker.com/products/docker-desktop. Once
64-
installed, start the Docker process.
60+
First install [Docker](https://www.docker.com/products/docker-desktop). Once
61+
installed, start the Docker desktop application.
6562

66-
Next check out or download the py38-app-engine branch of the glowscript repository (currently the `py38-app-engine` branch).
67-
(How you do this depends on your familiarity with git. The simplest is to download a .zip file of the
68-
`py38-app-engine` branch of the repository [here](https://github.com/vpython/glowscript/archive/py38-app-engine.zip))Then
69-
open a console in the `glowscript` directory of the repository and run the webserver and datastore in docker:
63+
Next check out or download the glowscript repository. Then:
7064

7165
docker-compose up
7266

@@ -82,26 +76,13 @@ When you're finished, shut down the system with:
8276

8377
docker-compose down
8478

85-
* P.S. If you're using windows an you want to use the "auto-restart" feature when code files change
86-
you'll need to run the filesystem monitoring tool
87-
[docker-windows-volume-watcher](https://pypi.org/project/docker-windows-volume-watcher/)
88-
89-
pip install docker-windows-volume-watcher
90-
91-
* And when you're running the glowscript server locally, in a *separate* window, execute:
92-
93-
docker-volume-watcher glowscript_flask_1
94-
95-
* and it will take care of the rest.
96-
9779
### Local Server Approach (2) Only Datastore In Docker
9880

9981
To run a local webserver with only the datastore in Docker, but the
100-
webserver itself running natively you need a recent version of Python3 and pip installed. The easiest method
82+
webserver itself running natively you need Python-3.8.3. The easiest method
10183
is probably to install [anaconda](https://docs.anaconda.com/anaconda/install/) (or [miniconda](https://docs.conda.io/en/latest/miniconda.html), if you don't want the GUI package manager and extra applications). Once you have that you need to check out
102-
or download the py38-app-engine branch of the glowscript repository (currently the `py38-app-engine` branch).
103-
(How you do this depends on your familiarity with git. The simplest is to download a .zip file of the
104-
`py38-app-engine` branch of the repository [here](https://github.com/vpython/glowscript/archive/py38-app-engine.zip))
84+
the glowscript repository.
85+
(How you do this depends on your familiarity with git. The simplest is to download a .zip file of the repository [here](https://github.com/vpython/glowscript/archive/refs/heads/master.zip))
10586
First "cd" to the `glowscript` directory (the root directory of the repository)
10687
and create a virtual environment for glowscript like so:
10788

0 commit comments

Comments
 (0)