Skip to content

Commit

Permalink
Convert README from Markdown to Org syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
viiru- committed Jun 28, 2024
1 parent 7c69f7d commit 4b61384
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 54 deletions.
54 changes: 0 additions & 54 deletions README.md

This file was deleted.

56 changes: 56 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
* pytrainer - Free your sports
pytrainer is a desktop application for logging and graphing sporting
activities such as running or cycling sessions. Data can be imported from GPS
devices, files or input manually. Currently pytrainer supports GPX, TCX, and
FIT files.

** Source Repository Structure
- *extensions* addons to extend pytrainer basic functionality
- *glade* user interface design
- *imports* files to parse different source formats
- *locale* localization files
- *man* source manpage
- *plugins* files to retrieve data from different sources
- *pytrainer* core files
- *schemas* schemas to support correct xml parsing
- *utils* localization shell script

** Installation from source tarball (using pip)
Copy tarball file to a location where you have write and execution
rights (e.g. =/tmp= or your =$HOME= directory). Make sure executables
are under your =$PATH=.

=$ tar -xzf pytrainer-X.Y.Z.tar.gz=

=$ cd pytrainer-X.Y.Z=

=$ pip install pycairo pygobject=

=$ pip install .=

=$ pytrainer -i=

** Installation from source tarball (deprecated method)
Copy tarball file to a location where you have write and execution
rights (e.g. =/tmp= or your =$HOME= directory). Make sure executables
are under your =$PATH=.

=$ tar -xzf pytrainer-X.Y.Z.tar.gz=

=$ cd pytrainer-X.Y.Z=

=$ sudo python setup.py install=

=$ pytrainer -i=

For more information about the process, please check [Distutils
documentation] (http://docs.python.org/3.11/distutils/setupscript.html)

** Further Resources
- FAQ [[https://github.com/pytrainer/pytrainer/wiki/FAQ]]
- Distribution list: [email protected]
- Development guide:
[[https://github.com/pytrainer/pytrainer/wiki/Development-guide]]
- Localization guide:
[[https://github.com/pytrainer/pytrainer/wiki/Localization-guide]]
- Report an Issue: [[https://github.com/pytrainer/pytrainer/issues]]

0 comments on commit 4b61384

Please sign in to comment.