Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterChmurciak authored May 4, 2022
1 parent 00ab45e commit 338988a
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# Uniformly-Spaced-Points-Selector
Python application with a simple GUI used for selecting a subset of uniformly spaced points.

# How to run

## (Optional) Create virtual envinronment
###### Using virtualenv
```
virtualenv venv
.\venv\Scripts\activate
```
###### Using conda
```
conda create -n venv python
conda activate venv
```
## Install the required packages
```
pip install -r .\requirements.txt
```
## (Optional) Specify your API key for Google Maps
In file
```
.\Dependencies\Subroutine_Select_The_Points.py
```
on line 357, modify the variable
```
apikey = '' # (your API key here)
```

## Run the main file
```
python Uniformly_Spaced_Points_Selector.py
```
## (Optional) Leave virtual envinronment
###### Using virtualenv
```
deactivate
```
###### Using conda
```
conda deactivate
```
# Work in progress
Readme will be updated with short guide and example with pictures in the near future.
Readme will be updated with explanation and pictures in the near future.

0 comments on commit 338988a

Please sign in to comment.