Skip to content

Commit

Permalink
docs: update README related to running from bash script
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniBodor committed Apr 18, 2024
1 parent 2cb74ce commit 6478890
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,22 @@ poetry install

### 2. Running EIT Dashboard

##### Stay up to date
##### Latest version

To ensure you are using the newest version, including any updates since you last used it, navigate to the folder where
the dashboard is installed and run:
To run the most up top date version of the dashboard (including any updates since you last used it), navigate to the
folder where the dashboard is installed and run `bash RUN` and open the link shown in a browser (often something like
`http://127.0.0.1:8050/`).
Note that while the dashboard should work on any browser, if you are experiencing issues we
recommend switching to Chrome or Firefox, as these are the browser where we do most of the testing.

```console
git pull
poetry install
```

Please see our [user manual](docs/user_manual.md) for instructions on how to use the dashboard.
##### Existing version

##### Run dashboard
If you want to run the dashboard without first updating to the lastest, follow instructions above, but run this command
instead: `poetry run python eit_dash/main.py`

Run the command below and and open the resulting link in a browser (often something like `http://127.0.0.1:8050/`).
Note that while the dashboard should work on any browser, if you are experiencing issues we recommend switching to
Chrome or Firefox, as these are the browser where we do most of the testing.
### 2. Using EIT Dashboard

```console
poetry run python eit_dash/main.py
```
Please see our [user manual](docs/user_manual.md) for instructions on how to use the dashboard.

## Documentation

Expand Down

0 comments on commit 6478890

Please sign in to comment.