From 83d87d5499fe78a2694295d282a499d76090340c Mon Sep 17 00:00:00 2001 From: cdknight Date: Tue, 7 Nov 2017 21:38:24 -0500 Subject: [PATCH] added 1st section to README I added an "ABOUT" section to README and updated the rest a tiny bit. --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 19c664475..be72605ff 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,30 @@ + + +# 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 for each platform; 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 @@ -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) -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