chris/OSCAR-code
1
0
Fork 0
mirror of https://gitlab.com/pholy/OSCAR-code.git synced 2025-04-05 02:30:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleaned up README file and added BUILD-Linux.md instructions

Browse Source
This commit is contained in:
Phil Olynyk 2020-04-23 16:11:48 -04:00
parent af9e420308
commit bfba818c58
2 changed files with 36 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Building/Linux/BUILD_Linux.md Normal file
View File

@ -0,0 +1,18 @@
Shadow building is recommneded to avoid cluttering up the git source code folder.
The following does not use the QT creator package, and assumes the directoy structure shown.
After installing the required packages:
$ mkdir OSCAR
$ cd OSCAR
$ git clone https://gitlab.com/pholy/OSCAR-code.git
$ mkdir build
$ cd build
$ qmake ../OSCAR-code/OSCAR_QT.pro.
$ make
After successful compilation, you can execute in place with ./oscar/OSCAR,
or build an installable package with one of the mkXXXX.sh scripts. It is recommended to create a
Packages folder within OSCAR and copy the scripts and associated files to it to avoid cluttering up the git source tree.

56
README
View File

@ -10,58 +10,36 @@ SleepyHead was written by Mark Watkins (aka Jedimark), an Australian software de
SleepyHead was copyright (C) 2011-2018 by Mark Watkins <mark@jedimark.net>
Portions of OSCAR are copyright (c) 2019 by Nightowl Software <michaelnightowl99@gmail.com>
Portions of OSCAR are copyright (c) 2019, 2020 by The OSCAR Team <oscar@oscar-team.org>
Windows Building: See Building\Windows\BUILD-WIN.md
-----------------
MacOS Building: See Building\Windows\BUILD-mac.md
---------------
Linux Requirements:
Minimum Requirements:
-------------------
Qt5.9 SDK with help (Qt5.9 from http://qt.io/download-open-source recommended)
The help modules are libqt5help5, qttools5-dev and qttools5-dev-tools
All systems need either qtcreator or qttools5-dev-tools and a C++ compiler and linker
Qt5.7 SDK without help is possible (for Debian Stretch)
All systems need the packages qt5-default, libqt5serialport5, libqt5serailport5-dev and libqt5opengl5-dev
All systems need qtcreator or qttools5-dev-tools
Oscar can be built without the Help module with Qt5.7 SDK (for Debian Stretch, for example)
The Help module (The Help texts are incomplete, and language support is incomplete) requires Qt5.9 SDK,
additionally, the QT modules libqt5help5, qttools5-dev, and qttools5-dev-tools are required.
All systems need qt5-default, libqt5serialport5, libqt5serailport5-dev and libqt5opengl5-dev
Linux also needs libudev-dev and zlib1g-dev
The current pre-built downloads use the distribution-supplied version of Qt.
OSX needs Xcode and commandline tools from AppStore,
OSX needs an Xcode version that supports the version of Qt to be used, and commandline tools from AppStore,
The current pre-built downloads use Qt5.12.8.
Windows needs MinGW (in Qt5 SDK) or VC++2015 Community, and a matching set of Qt libraries.
The current pre-built downloads use Qt5.12.8.
Linux Building:
Windows Building: See Building/Windows/BUILD-WIN.md
-----------------
MacOS Building: See Building/Windows/BUILD-mac.md
---------------
Recommend shadow building to not cruft up the source code folder:
cd ..
mkdir build
cd build
qmake ../OSCAR-code/OSCAR_QT.pro
make
You may need to add a -spec option to qmake to suit your platform.
Adding -j4 speeds up the make command on a dual core or greater system.
Building on OSX:
Linux Building: See Building/Windows/BUILD-Linux-md
---------------
Build as above. If qmake fails with the error:
Project ERROR: Xcode not set up properly. You may need to confirm the license agreement by running /usr/bin/xcodebuild
edit the file:
QT_INSTALL_DIR/5.9/clang_64/mkspecs/features/mac/default_pre.prf
and replace
/usr/bin/xcrun -find xcrun 2>/dev/null
with
/usr/bin/xcrun -find xcodebuild 2>/dev/null
Software Licensing Information
------------------------------