Go to file
Toon Verstraelen 8f2af5b228 Add Fedora packages to README and add sudo before apt 2018-11-10 08:26:50 +00:00
.appveyor Misc. typos 2018-09-19 18:52:11 +00:00
.github github: add an ISSUE_TEMPLATE file. 2016-12-13 11:44:31 +00:00
.travis CMake: support sanitizers on gcc builds, too. 2018-07-11 04:52:11 +00:00
bench Fix benchmark harness after e2e74762. 2017-03-17 15:24:32 +00:00
cmake Add a platform abstraction for 6-DOF input devices. 2018-07-18 01:05:19 +00:00
exposed Remove double word in DOC.txt 2018-08-01 21:06:06 +00:00
extlib macOS: bundle and statically link external dependencies. 2018-07-12 11:15:31 +00:00
include Enable -Wall -Wextra -Wno-unused-parameter on GCC/Clang. 2016-05-08 00:01:35 +00:00
res Misc. typos 2018-09-19 18:52:11 +00:00
src cli: fix typo. 2018-11-08 04:10:14 +00:00
test Adjust the horizontal constraint label margin to equal vertical. 2018-07-31 17:21:15 +00:00
.gitattributes Add a simple harness for automated, headless testing. 2016-08-01 00:48:37 +00:00
.gitignore Highlight normals and circle radii that have a degree of freedom. 2017-02-17 04:14:36 +00:00
.gitmodules extlib: use https:// URL for the freetype submodule. 2018-07-31 16:58:32 +00:00
.travis.yml macOS: rename application bundle to SolveSpace. 2018-07-17 15:01:58 +00:00
CHANGELOG.md Implement a platform abstraction for windows. 2018-07-17 13:31:17 +00:00
CMakeLists.txt CMake: add an ENABLE_CLI flag. 2018-07-18 11:49:06 +00:00
CONTRIBUTING.md Fix various comment and UI string typos. 2018-07-12 05:05:43 +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 Add Fedora packages to README and add sudo before apt 2018-11-10 08:26:50 +00:00
appveyor.yml Appveyor: add IRC notifications. 2018-07-12 23:06:07 +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.

Community

The official SolveSpace website has tutorials, reference manual and a forum; there is also an official IRC channel #solvespace at irc.freenode.net.

Installation

Via official binary packages

Official release binary packages for macOS (>=10.6 64-bit) and Windows (>=Vista 32-bit) are available via GitHub releases. These packages are automatically built by the SolveSpace maintainers for each stable release.

Via third-party binary packages

Third-party nightly binary packages for Debian and Ubuntu are available via notesalexp.org. These packages are automatically built from non-released source code. The SolveSpace maintainers do not control the contents of these packages and cannot guarantee their functionality.

Via source code

See below.

Building on Linux

Building for Linux

You will need the usual build tools, CMake, zlib, libpng, cairo, freetype. To build the GUI, you will need fontconfig, gtkmm 3.0 (version 3.16 or later), pangomm 1.4, OpenGL and OpenGL GLU, and optionally, the Space Navigator client library. On a Debian derivative (e.g. Ubuntu) these can be installed with:

sudo apt install git build-essential cmake zlib1g-dev libpng-dev \
                 libcairo2-dev libfreetype6-dev libjson-c-dev \
                 libfontconfig1-dev libgtkmm-3.0-dev libpangomm-1.4-dev \
                 libgl-dev libglu-dev libspnav-dev

On a Redhat derivative (e.g. Fedora) the dependencies can be installed with:

sudo dnf install git gcc-c++ cmake zlib-devel libpng-devel \
                 cairo-devel freetype-devel json-c-devel \
                 fontconfig-devel gtkmm30-devel pangomm-devel \
                 mesa-libGL-devel mesa-libGLU-devel libspnav-devel

Before building, check out the project and the necessary submodules:

git clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update --init extlib/libdxfrw

After that, build SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make
sudo make install

The graphical interface is built as build/bin/solvespace, and the command-line interface is built as build/bin/solvespace-cli. It is possible to build only the command-line interface by passing the -DENABLE_GUI=OFF flag to the cmake invocation.

Building for Windows

You will need the usual build tools, CMake and a Windows cross-compiler. On a Debian derivative (e.g. Ubuntu) these can be installed with:

apt-get install git build-essential cmake mingw-w64

Before building, check out the project and the necessary submodules:

git clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update

After that, build 32-bit SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw32.cmake \
         -DCMAKE_BUILD_TYPE=Release
make

Or, build 64-bit SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw64.cmake \
         -DCMAKE_BUILD_TYPE=Release
make

The graphical interface is built as build/bin/solvespace.exe, and the command-line interface is built as build/bin/solvespace-cli.exe.

Space Navigator support will not be available.

Building on macOS

You will need git, XCode tools and CMake. Git and CMake can be installed via Homebrew:

brew install git cmake

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

Before building, check out the project and the necessary submodules:

git clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update --init

After that, build SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make

Alternatively, generate an XCode project, open it, and build the "Release" scheme:

mkdir build
cd build
cmake .. -G Xcode

The application is built in build/bin/SolveSpace.app, the graphical interface executable is build/bin/SolveSpace.app/Contents/MacOS/SolveSpace, and the command-line interface executable is build/bin/SolveSpace.app/Contents/MacOS/solvespace-cli.

Building on OpenBSD

You will need git, cmake, libexecinfo, libpng, gtk3mm and pangomm. These can be installed from the ports tree:

pkg_add -U git cmake libexecinfo png json-c gtk3mm pangomm

Before building, check out the project and the necessary submodules:

git clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update --init extlib/libdxfrw

After that, build SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make

Unfortunately, on OpenBSD, the produced executables are not filesystem location independent and must be installed before use. By default, the graphical interface is installed to /usr/local/bin/solvespace, and the command-line interface is built as /usr/local/bin/solvespace-cli. It is possible to build only the command-line interface by passing the -DENABLE_GUI=OFF flag to the cmake invocation.

Building on Windows

You will need git, cmake and Visual C++.

Building with Visual Studio IDE

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.

Building with Visual Studio in a command prompt

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 clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update --init
mkdir build
cd build
cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release
nmake

Building with MinGW

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 clone https://github.com/solvespace/solvespace
cd solvespace
git submodule update --init
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make

Contributing

See the guide for contributors for the best way to file issues, contribute code, and debug SolveSpace.

License

SolveSpace is distributed under the terms of the GPL3 license.