Go to file
whitequark f4c01f670c Implement a resource system.
Currently, icons, fonts, etc are converted to C structures at compile
time and are hardcoded to the binary. This presents several problems:

  * Cross-compilation is complicated. Right now, it is necessary
    to be able to run executables for the target platform; this
    happens to work with wine-binfmt installed, but is rather ugly.

  * Icons can only have one resolution. On OS X, modern software is
    expected to take advantage of high-DPI ("Retina") screens and
    use so-called @2x assets when ran in high-DPI mode.

  * Localization is complicated. Win32 and OS X provide built-in
    support for loading the resource appropriate for the user's
    locale.

  * Embedding strings can only be done as raw strings, using C++'s
    R"(...)" literals. This precludes embedding sizable strings,
    e.g. JavaScript libraries as used in Three.js export, and makes
    git history less useful. Not embedding the libraries means we
    have to rely on external CDNs, which requires an Internet
    connection and adds a glaring point of failure.

  * Linux distribution guidelines are violated. All architecture-
    independent data, especially large data such as fonts, is
    expected to be in /usr/share, not in the binary.

  * Customization is impossible without recompilation. Minor
    modifications like adding a few missing vector font characters
    or adjusting localization require a complete development
    environment, which is unreasonable to expect from users of
    a mechanical CAD.

As such, this commit adds a resource system that bundles (and
sometimes builds) resources with the executable. Where they go is
platform-dependent:

  * on Win32: into resources of the executable, which allows us to
    keep distributing one file;
  * on OS X: into the app bundle;
  * on other *nix: into /usr/share/solvespace/ or ../res/ (relative
    to the executable path), the latter allowing us to run freshly
    built executables without installation.

It also subsides the platform-specific resources that are in src/.

The resource system is not yet used for anything; this will be added
in later commits.
2016-05-18 11:24:23 +00:00
.travis Update CI scripts to respect the vA.B tag name format. 2016-05-17 14:53:36 +00:00
cmake Embed git commit hash in the "About" dialog. 2016-04-23 22:53:21 +00:00
debian Prepare CI for release builds. 2016-04-23 04:38:32 +00:00
exposed Enable -Wall -Wextra -Wno-unused-parameter on GCC/Clang. 2016-05-08 00:01:35 +00:00
extlib DXF: export "actual measurement" for dimensions. 2016-05-17 12:34:35 +00:00
include Enable -Wall -Wextra -Wno-unused-parameter on GCC/Clang. 2016-05-08 00:01:35 +00:00
res Implement a resource system. 2016-05-18 11:24:23 +00:00
src Implement a resource system. 2016-05-18 11:24:23 +00:00
tools Perform grid fitting on the builtin vector font. 2016-04-16 04:19:14 +00:00
.gitattributes Added a .gitattributes file 2013-11-19 18:17:55 -05:00
.gitignore Build Debian packages with debug symbols. 2016-01-13 06:45:17 +00:00
.gitmodules Move everything from whitequark/solvespace to solvespace/solvespace. 2016-04-23 19:39:39 +00:00
.travis.yml Move everything from whitequark/solvespace to solvespace/solvespace. 2016-04-23 19:39:39 +00:00
CMakeLists.txt Implement a resource system. 2016-05-18 11:24:23 +00:00
COPYING.txt Changes in preparation for the release of SolveSpace under the GPL, 2013-07-28 14:08:34 -08:00
README.md Move everything from whitequark/solvespace to solvespace/solvespace. 2016-04-23 19:39:39 +00:00
appveyor.yml Update CI scripts to respect the vA.B tag name format. 2016-05-17 14:53:36 +00:00
wishlist.txt Make oops() calls exit instead of entering debugger by default, 2011-03-05 12:52:57 -08:00

README.md

SolveSpace

This repository contains the source code of SolveSpace, a parametric 2d/3d CAD.

Installation

Mac OS X (>=10.6 64-bit), Debian (>=jessie) and Ubuntu (>=trusty)

Binary packages for Mac OS X and Debian derivatives are available via GitHub releases.

Other systems

See below.

Building on Linux

Building for Linux

You will need CMake, libpng, zlib, json-c, fontconfig, freetype, gtkmm 2.4, pangomm 1.4, OpenGL and OpenGL GLU. On a Debian derivative (e.g. Ubuntu) these can be installed with:

apt-get install libpng12-dev libjson-c-dev libfreetype6-dev \
                libfontconfig1-dev libgtkmm-2.4-dev libpangomm-1.4-dev \
                libgl-dev libglu-dev libglew-dev cmake

Before building, check out the necessary submodules:

git submodule update --init extlib/libdxfrw

After that, build SolveSpace as following:

mkdir build
cd build
cmake ..
make
sudo make install

A fully functional port to GTK3 is available, but not recommended for use due to bugs in this toolkit.

Building for Windows

You will need CMake, a Windows cross-compiler, and Wine with binfmt support. On a Debian derivative (e.g. Ubuntu) these can be installed with:

apt-get install cmake mingw-w64 wine-binfmt

Before building, check out the necessary submodules:

git submodule update --init

After that, build 32-bit SolveSpace as following:

mkdir build
cd build
cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw32.cmake ..
make solvespace

Or, build 64-bit SolveSpace as following:

mkdir build
cd build
cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw64.cmake ..
make solvespace

The application is built as build/src/solvespace.exe.

Space Navigator support will not be available.

Building on Mac OS X

You will need XCode tools, CMake, libpng and Freetype. Assuming you use homebrew, these can be installed with:

brew install cmake libpng freetype

XCode has to be installed via AppStore; it requires a free Apple ID.

Before building, check out the necessary submodules:

git submodule update --init extlib/libdxfrw

After that, build SolveSpace as following:

mkdir build
cd build
cmake ..
make

The app bundle is built in build/src/solvespace.app.

Building on Windows

You will need cmake and Visual C++.

GUI build

Check out the git submodules. Create a directory build in the source tree and point cmake-gui to the source tree and that directory. Press "Configure" and "Generate", then open build\solvespace.sln with Visual C++ and build it.

Command-line build

First, ensure that git and cl (the Visual C++ compiler driver) are in your %PATH%; the latter is usually done by invoking vcvarsall.bat from your Visual Studio install. Then, run the following in cmd or PowerShell:

git submodule update --init
mkdir build
cd build
cmake .. -G "NMake Makefiles"
nmake

MSVC build

It is also possible to build SolveSpace using MinGW, though Space Navigator support will be disabled.

First, ensure that git and gcc are in your $PATH. Then, run the following in bash:

git submodule update --init
mkdir build
cd build
cmake ..
make

License

SolveSpace is distributed under the terms of the GPL3 license.