Commit 54ddac16 authored by Andy Regensky's avatar Andy Regensky
Browse files

Define module executable and update README.md

parent cde3d19d
......@@ -6,7 +6,7 @@ the fisheye domain experiences in the perspective domain and vice versa.
## Setup
Download or clone this repository and enter the main folder. Python 3 is required to
run the application `main.py`. Furthermore, the following dependencies need to be
run the application. Furthermore, the following dependencies need to be
installed:
* numpy
* pyside2
......@@ -18,8 +18,18 @@ dependencies pre-installed can be created by executing
$ conda create -n FishUI numpy pyside2
```
in the terminal. The FishUI application can then be started by activating the environment
and running `main.py`.
and running the fishui module.
```sh
$ conda activate FishUI
$ python main.py
```
\ No newline at end of file
$ python -m fishui
```
Note that you need to be located in the main folder for this to work.
```
main folder
├── fishui
│   ├── ...
│  
└── README.md
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment