added 1st section to README

I added an "ABOUT" section to README and updated the rest a tiny bit.
This commit is contained in:
cdknight
2017-11-07 21:38:24 -05:00
parent 0ff2a3088c
commit 83d87d5499

View File

@@ -1,9 +1,30 @@
<img src="src/Resources/images/gc.png" height="25%" width="25%">
# GoldenCheetah
## About
GoldenCheetah is an open-source data analysis tool primarily written in C++
with Qt for cyclists and triathletes
with support for training as well.
GoldenCheetah can connect with indoor trainers and cycling equipment such
as cycling computers and power meters to import data.
In addition, GoldenCheetah can connect to cloud services.
It can then manipulate and view the data, as well as analyze it.
## Installing
Golden Cheetah install and build instructions are documented Golden Cheetah install and build instructions are documented
for each platform; for each platform;
INSTALL-WIN32 For building on Microsoft Windows INSTALL-WIN32 For building on Microsoft Windows
INSTALL-LINUX For building on Ubuntu Linux INSTALL-LINUX For building on Linux
INSTALL-MAC For building on Apple OS X INSTALL-MAC For building on Apple OS X
@@ -14,6 +35,6 @@ Windows: [![Build status](https://ci.appveyor.com/api/projects/status/i6dwn4m8oy
[![Coverity Status](https://scan.coverity.com/projects/7503/badge.svg)](https://scan.coverity.com/projects/goldencheetah-goldencheetah) [![Coverity Status](https://scan.coverity.com/projects/7503/badge.svg)](https://scan.coverity.com/projects/goldencheetah-goldencheetah)
Alternatively official builds are available from http://www.goldencheetah.org Alternatively, official builds are available from http://www.goldencheetah.org
whilst latest developer builds are available from https://github.com/GoldenCheetah/GoldenCheetah/releases whilst the latest developer builds are available from https://github.com/GoldenCheetah/GoldenCheetah/releases