Skip to content

Commit

Permalink
🎨 improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasParistech committed Sep 12, 2024
1 parent 375bc72 commit f3815d9
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,40 @@ Here's a demo GIF to give you a glimpse of a user interacting with the webapp an

![](./doc/demo.gif)

# Usage
# Installation

### Option 1: Install Locally

Make sure you have Python version 3.10 or higher installed.

Install the dependencies.
```
pip3 install -r .devcontainer/requirements
```

And run the webapp.
In ubuntu, install the packages.
```
sudo xargs -a .devcontainer/packages.txt apt-get install -y
```


### Option 2: Open in VS Code with Dev Containers

If you are using Visual Studio Code, you can take advantage of the Dev Containers feature:
* Install the Remote - Containers extension in VS Code.
* Open this project folder in VS Code.
* When prompted, select Reopen in Container.

This will open the project in a fully configured container environment based on the `.devcontainer` configuration, allowing you to work without manually setting up dependencies.

### Run

Finally, run the webapp.
```
python3 pretty_gpx/main.py
```


# Features

This app is the perfect companion for cycling or hiking enthusiasts tackling routes with significant elevation gain.
Expand Down Expand Up @@ -82,7 +104,13 @@ python3 pretty_gpx/explore_color_themes.py
```


# Simplify a GPX file

If your GPX file is quite heavy, e.g. 20Mo, you can the following script to make it lighter.

```
python3 pretty_gpx/simplify_gpx.py --input <GPX_FILE>
```

# Examples

Expand Down

0 comments on commit f3815d9

Please sign in to comment.