v0.1.5 for publication

README.md

@@ -17,10 +17,10 @@ An easy-to-use, standalone and open-source motion tracking application for resea
 For the complete list of features please check the [documentation](https://github.com/flochkristof/motiontracker/blob/main/docs/GUIDE.pdf).
 
 ## Dependencies
-The Graphical user interface was created with the [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) framework. For the handling of video files and to do the actual tracking the [OpenCV](https://opencv.org/) library was used with its built in tracking algorithms. Numerical differentiations are carried out using the [PyNumDiff](https://github.com/florisvb/PyNumDiff). Plots and figures are generated by [matplotlib](https://matplotlib.org/). For the complete list of required packages check [pyproject.toml](https://github.com/flochkristof/motiontracker/blob/main/pyproject.toml) [requirements.txt](https://github.com/flochkristof/motiontracker/blob/main/requirements.txt)
+The Graphical user interface was created with the [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) framework. For the handling of video files and to do the actual tracking the [OpenCV](https://opencv.org/) library was used with its built in tracking algorithms. Numerical differentiations are carried out using the [PyNumDiff](https://github.com/florisvb/PyNumDiff). Plots and figures are generated by [matplotlib](https://matplotlib.org/). For the complete list of required packages check [pyproject.toml](https://github.com/flochkristof/motiontracker/blob/main/pyproject.toml) or [requirements.txt](https://github.com/flochkristof/motiontracker/blob/main/requirements.txt)
 
 ## Installation
-### Download & install via PyPI
+### Download & install via PyPI (recommended)
 ```
 $ pip install MotionTrackerBeta
 ```
@@ -29,8 +29,8 @@ $ pip install MotionTrackerBeta
 $ MotionTrackerBeta
 ```
 ### Download & install the wheel file
-- Download the `.whl` file from the latest release
-- Execute
+- Download the `.whl` file from the latest [release](https://github.com/flochkristof/motiontracker/releases)
+- Intall with pip>
 ```
 $ pip install <path-to-wheel-file.whl>
 ```
@@ -39,20 +39,38 @@ $ pip install <path-to-wheel-file.whl>
 $ MotionTrackerBeta
 ```
 
+### Download & build from source
+- Download the source from the latest [release](https://github.com/flochkristof/motiontracker/releases) or clone the repository
+```
+$ git clone https://github.com/flochkristof/motiontracker.git
+```
+- Build with [poetry](https://python-poetry.org/):
+```
+$ poetry build
+```
+- Install with pip
+```
+$ pip install dist/motiontrackerbeta-<version>-py3-none-any.whl
+```
+- Run the application
+```
+$ MotionTrackerBeta
+```
+
 ### Download binaries (Windows)
 - Download the binaries from the latest release
 - Extract it to your specified location
-- Open application with `Motion Tracker Beta.exe`
+- Run application with `Motion Tracker Beta.exe`
 ### Download the installer (Windows)
 - Download the installer from the latest release
 - Run the installer and follow the instructions
-- After successfull installation the software is accessible under the name `Motion Tracker Beta`
+- After successful installation the software is accessible under the name `Motion Tracker Beta`
 ###
 # Usage
 For a detailed guide about the software check out the [documentation](docs/DOCUMENTATION.pdf). A video that intorduces the main features and functions of the software is also available [online](https://www.youtube.com/watch?v=q3eWOA0FEmk).
 # License
 Motion Tracker Beta is released under the `GNU General Public License v3.0`.
 # Author
-The software was developed by Kristof Floch at the Department of Applied Mechanics, Faculty of Mechanical Engineering, Budapest University of Technology and Economics.
+The software has been developed by Kristof Floch at the Department of Applied Mechanics, Faculty of Mechanical Engineering, Budapest University of Technology and Economics.
 ### Contact
 - E-mail: [email protected]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "MotionTrackerBeta"
-version = "0.1.4"
+version = "0.1.5"
 description = "a GUI based, open-source motion tracking application"
 authors = ["Kristof Floch <[email protected]>"]
 maintainers = ["Kristof Floch <[email protected]>"]
@@ -38,7 +38,7 @@ cvxopt = "^1.3.0"
 cvxpy = "^1.2.0"
 pandas = "^1.4.2"
 #pynumdiff = "^0.1.2" 
-{git = "https://github.com/flochkristof/PyNumDiff.git"}
+pynumdiff = {git = "https://github.com/flochkristof/PyNumDiff.git"}
 pychebfun = {git = "https://github.com/flochkristof/pychebfun.git"}
 openpyxl = "^3.0.10"