Go to file
KmolYuan 3c98d4d270 Bump version. 2021-12-11 17:46:28 +08:00
.github Simplify CI scripts. 2021-12-03 18:04:19 +08:00
bench Refactor InitPlatform. 2020-05-10 08:29:25 +00:00
cmake Add apple arm64 support 2021-04-04 11:40:10 -04:00
cython Bump version. 2021-12-11 17:46:28 +08:00
developer_docs Fix various typos 2021-07-06 10:37:58 -04:00
exposed Revert "CMake: use sanitizer flags for internal targets only" 2020-10-24 17:10:47 +02:00
extlib Add apple arm64 support 2021-04-04 11:40:10 -04:00
include Addition of ArcLength Ratio and ArcLength Difference constraints to Constraints list 2021-06-28 11:31:53 -04:00
pkg Update flatpak manifest more. 2021-04-22 15:48:16 -04:00
res Update Russian translation 2021-10-04 20:52:24 +03:00
src Merge branch 'solvespace:master' into python 2021-12-02 09:18:36 +08:00
test Skip image rendering in CLI rather than hard abort 2021-04-03 22:58:05 +03:00
.clang-format Modify clang-format config to avoid single-line things. NFC. 2019-09-11 09:43:03 +00:00
.gitattributes Revert "CMake: replace GetGitCommitHash with .gitattributes and $Id$." 2019-05-01 08:32:59 +00:00
.gitignore Merge from original repo. 2021-02-12 11:15:04 +08:00
.gitmodules Remove Q3DO export. 2020-11-21 13:02:39 -05:00
CHANGELOG.md Update CHANGELOG.md 2021-08-27 19:38:26 -04:00
CMakeLists.txt Set OSX minimum supported version 2021-08-15 12:28:46 -04:00
CONTRIBUTING.md Clarify ambiguous license terms. 2021-02-25 20:37:18 -08:00
COPYING.txt Changes in preparation for the release of SolveSpace under the GPL, 2013-07-28 14:08:34 -08:00
README.md CI: Replace edge releases with links to artifacts 2021-10-29 16:47:38 -04:00
THIRD_PARTIES.txt Add a built-in Bitstream Vera Sans Roman font. 2019-02-11 11:03:47 +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 Logo

SolveSpace

Build Status solvespace 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 Snap Store

Official releases can be installed from the stable channel.

Builds from master are automatically released to the edge channel in the Snap Store. Those packages contain the latest improvements, but receive less testing than release builds.

Get it from the Snap Store

Or install from a terminal:

# for the latest stable release:
snap install solvespace 
# for the bleeding edge builds from master:
snap install solvespace --edge

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 automated edge builds

⚠️ Edge builds might be unstable or contain severe bugs! They are intended for experienced users to test new features or verify bugfixes.

Cutting edge builds from the latest master commit are available as zip archives from the following links:

Extract the downloaded archive and install or execute the contained file as is appropriate for your platform.

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 extlib/mimalloc

After that, build SolveSpace as following:

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

Link Time Optimization is supported by adding -DENABLE_LTO=ON to cmake at the expense of longer build time.

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

Ubuntu will require 20.04 or above. Cross-compiling with WSL is also confirmed to work.

You will need the usual build tools, CMake, a Windows cross-compiler, and flatc. 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 --init

Build 64-bit SolveSpace with the following:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw64.cmake \
         -DCMAKE_BUILD_TYPE=Release \
         -DFLATC=$(which flatc)
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.

If using Ubuntu to cross-compile, Ubuntu 17.10 or newer (or, alternatively, MinGW from the Ubuntu 17.10 repositories) is required.

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 -DENABLE_OPENMP=ON
make

Link Time Optimization is supported by adding -DENABLE_LTO=ON to cmake at the expense of longer build time.

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 extlib/mimalloc

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 a C++ compiler (either Visual C++ or MinGW). If using Visual C++, Visual Studio 2015 or later is required.

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 GPL v3 or later.