readme verder uitgebreid
authorwim
Wed, 30 Aug 2017 17:53:53 +0200
changeset 11 35951602f83e
parent 10 89108adbc468
child 12 1d6e37b3ebf2
readme verder uitgebreid
README.md
--- a/README.md	Wed Aug 30 12:37:28 2017 +0200
+++ b/README.md	Wed Aug 30 17:53:53 2017 +0200
@@ -1,25 +1,32 @@
 # gpx_reduce_light
 
-* gpx_reduce.py, a version of gpx_reduce with no dependencies (only the standard python libraries)  
-Only the plot option has been removed.
-See [original version](https://github.com/Alezy80/gpx_reduce) for more info.
+* gpx_reduce.py is a version of the [original gpx_reduce][1] with no dependencies.
+
+    The [original version][1] depends on scipy, lxml, numpy and pylab.
+    Because the program only does some basic linear algebra, all these dependencies can be easily removed.
+    This has two benefits:
 
->Usage example:
+    1. easy installation (nothing needed apart from python)
+    2. the program is considerably faster than the original.  
+        This is because the original uses a numpy array for each trackpoint which
+        incurs a large overhead for creating and for all subsequent little computations.
 
->>```
-$ gpx_reduce.py -d 2 -t 30 your_track.gpx
-```
+    The one disadvantage of removing all depecencies is that the plot option had to be removed.  
+    Usage example:
 
-* gpx_plot.py, a separate program to plot one or more tracks with "gnuplot".  
-Gnuplot has to be installed and the path to the binary has to be changed in the code
-to reflect your installation:
+        > gpx_reduce.py -d 2 -t 30 your_track.gpx
+
+    I made a separate python script with one dependency for plotting tracks:
+
+* gpx_plot.py, a script to plot one or more tracks with "gnuplot".
 
->>```
-gnuPlotCmd = 'path/to/gnuplot'
-```
+    Gnuplot has to be installed and the path to the binary has to be changed in the code
+    to reflect your installation:
+
+        gnuPlotCmd = 'path/to/gnuplot'
 
->Usage example that compares a reduced track with the original:
+    Usage example that compares a reduced track with the original:
 
->>```
-gpx_plot.py your_track.gpx your_track_reduced.gpx
-```
+        > gpx_plot.py your_track.gpx your_track_reduced.gpx
+
+[1]: https://github.com/Alezy80/gpx_reduce/
\ No newline at end of file