OSCAR-code/README

SleepyHead v1.0 branch

SleepyHead is cross platform, opensource sleep tracking program for reviewing CPAP and Oximetry data, 
which are devices used in the treatment of Sleep Disorders like Obstructive Sleep Apnea.

SleepyHead is written by Mark Watkins (aka Jedimark), an Australian software developer afflicted with sleep apnea.

SleepyHead is copyright (C) 2011-2016 Mark Watkins <mark@jedimark.net>

Requirements:
-------------
Qt5 SDK with webkit (Qt5.5 from http://qt.io/download-open-source recommended)
Linux needs libudev-dev for qserialport to compile

OSX needs Xcode and commandline tools from AppStore

Windows needs MinGW (in Qt5 SDK) or VC++2013 Express (and matching Qt libraries)

Building:
--------

Recommend shadow building to not cruft up the source code folder:

cd ..
mkdir build_sleepyhead
cd build_sleepyhead
qmake ../sleepyhead-code/SleepyHeadQT.pro 
make

You may need to add a -spec option to qmake to suit your platform. 
Adding -j3 speeds up the make command on a dual core or greater system.


Software Licensing Information
------------------------------
SleepyHead is released under the GNU GPL v3 License. Please see below for a note on giving correct attribution in redistribution of derivatives.

It is built using Qt SDK (Open Source Edition), available from http://qt.io.

It also uses QuaZip, by Sergey A. Tachenov, which is a C++ wrapper over Gilles Vollant's ZIP/UNZIP package http://sourceforge.net/projects/quazip/

Redistribution of derivatives
-----------------------------
I created this software to help lessen the exploitation of others. Seeing my work being used to exploit others is incredibly un-motivational, and incredibly disrespectful of all the work I put into this project.

If you plan on reselling any derivatives of SleepyHead, I specifically request that you give due credit and link back, mentioning clearly in your advertising material, software installer and about screens that your derivative "is based on the free and open-source software SleepyHead available from http://sleepyhead.jedimark.net, developed by Mark Watkins (C) 2011-<current year>. "

It is not enough to reference that your derivative "is based on GPL software".
Update README 2016-03-13 08:31:35 +00:00			`SleepyHead v1.0 branch`
gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00
Loading screen time is too short, so just display welcome page.. Fix zoom in too close makes cpap pressure dissapear bug 2011-12-25 08:17:24 +00:00			`SleepyHead is cross platform, opensource sleep tracking program for reviewing CPAP and Oximetry data,`
			`which are devices used in the treatment of Sleep Disorders like Obstructive Sleep Apnea.`
gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00
Fix spelling mistake and update README.TXT a little 2016-04-15 01:15:07 +00:00			`SleepyHead is written by Mark Watkins (aka Jedimark), an Australian software developer afflicted with sleep apnea.`

			`SleepyHead is copyright (C) 2011-2016 Mark Watkins <mark@jedimark.net>`

Mega update: Summary demand loading, Overview summarychart rework, rxchanges caching 2014-09-11 14:23:08 +00:00			`Requirements:`
			`-------------`
Update README 2016-03-13 08:31:35 +00:00			`Qt5 SDK with webkit (Qt5.5 from http://qt.io/download-open-source recommended)`
Mega update: Summary demand loading, Overview summarychart rework, rxchanges caching 2014-09-11 14:23:08 +00:00			`Linux needs libudev-dev for qserialport to compile`

Update README 2016-03-13 08:31:35 +00:00			`OSX needs Xcode and commandline tools from AppStore`

			`Windows needs MinGW (in Qt5 SDK) or VC++2013 Express (and matching Qt libraries)`
Mega update: Summary demand loading, Overview summarychart rework, rxchanges caching 2014-09-11 14:23:08 +00:00
			`Building:`
			`--------`
gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00
Mega update: Summary demand loading, Overview summarychart rework, rxchanges caching 2014-09-11 14:23:08 +00:00			`Recommend shadow building to not cruft up the source code folder:`

			`cd ..`
			`mkdir build_sleepyhead`
			`cd build_sleepyhead`
			`qmake ../sleepyhead-code/SleepyHeadQT.pro`
Missing files 2011-06-26 09:14:18 +00:00			`make`
gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00
Loading screen time is too short, so just display welcome page.. Fix zoom in too close makes cpap pressure dissapear bug 2011-12-25 08:17:24 +00:00			`You may need to add a -spec option to qmake to suit your platform.`
			`Adding -j3 speeds up the make command on a dual core or greater system.`


gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00
Fix spelling mistake and update README.TXT a little 2016-04-15 01:15:07 +00:00			`Software Licensing Information`
			`------------------------------`
			`SleepyHead is released under the GNU GPL v3 License. Please see below for a note on giving correct attribution in redistribution of derivatives.`

			`It is built using Qt SDK (Open Source Edition), available from http://qt.io.`

			`It also uses QuaZip, by Sergey A. Tachenov, which is a C++ wrapper over Gilles Vollant's ZIP/UNZIP package http://sourceforge.net/projects/quazip/`

			`Redistribution of derivatives`
			`-----------------------------`
			`I created this software to help lessen the exploitation of others. Seeing my work being used to exploit others is incredibly un-motivational, and incredibly disrespectful of all the work I put into this project.`

			`If you plan on reselling any derivatives of SleepyHead, I specifically request that you give due credit and link back, mentioning clearly in your advertising material, software installer and about screens that your derivative "is based on the free and open-source software SleepyHead available from http://sleepyhead.jedimark.net, developed by Mark Watkins (C) 2011-<current year>. "`

			`It is not enough to reference that your derivative "is based on GPL software".`
gLineChart improvements, screenshot fixes for linux build. 2011-05-28 09:16:46 +00:00