From e93f6aefc5d67e4486c1371767faf13c25ceb621 Mon Sep 17 00:00:00 2001 From: Michael Mann Date: Wed, 12 Jun 2024 20:36:36 -0400 Subject: [PATCH] update instructions --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2d4768a..535343c 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,26 @@ Executable files for `OSx`, `Windows` and `linux` are available for download: **Note:** Make sure to download and update `example_config.yaml` -## Python Installation & Execution +## Running the Application +1) Update the contents of `config.yaml` file with the desired bounding box, usernames, and optional date. -Install directly from GitHub using a terminal window: +2) Run the application using one of the following methods:
-```bash -pip install git+https://github.com/mmann1123/OSM_LeaderBoard.git -``` + A) **From the downloaded executable file**: Double click on the downloaded executable file to run the application. -Once installed simply type: + B) **From Python**: From the terminal window, navigate to the directory where the `dash_app.py` file is located. To download and run the application, use the following command: -```bash -leaderboard -``` + ```bash + pip install git+https://github.com/mmann1123/OSM_LeaderBoard.git + ``` + + Once installed simply type: + + ```bash + leaderboard + ``` + + 3) Then in the browser window select or drag your `config.yaml` file to the upload box. The leaderboard will be displayed in the browser window once the api calls are complete. ## Configuration @@ -56,19 +63,6 @@ newer_than_date: "2010-12-01" ``` -## Running the Application - -1) **From the downloaded executable file**: double click on the file to run the application. Then select or drag your `config.yaml` file to the upload box. The leaderboard will be displayed in the browser window once the api calls are complete. - -2) **From Python**: From the terminal window, navigate to the directory where the `dash_app.py` file is located. To download and run the application, use the following command: - - ```bash - git clone https://github.com/mmann1123/OSM_LeaderBoard.git - cd OSM_LeaderBoard/osm_leaderboard - python dash_app.py - ``` - - In the browser window select or drag your `config.yaml` file to the upload box. The leaderboard will be displayed in the browser window once the api calls are complete. # Demo