Go to file
ZHOU You 2be2e428d3 Chinese translation added. 2020-10-20 11:08:34 -04:00
.github Use HTML comments in issue template. 2020-05-21 11:39:37 +00:00
.travis Travis: update travis and macos build configs 2020-10-20 11:03:13 -04:00
bench Refactor InitPlatform. 2020-05-10 08:29:25 +00:00
cmake Revert "CMake: replace GetGitCommitHash with .gitattributes and $Id$." 2019-05-01 08:32:59 +00:00
developer_docs Added developer instructions for creating new entity transformations in the solver. (#491) 2020-03-27 15:08:35 -04:00
exposed Remove double word in DOC.txt 2018-08-01 21:06:06 +00:00
extlib Allow DXF import of 3D arcs and circles 2020-10-01 12:59:43 -04:00
include Enable -Wall -Wextra -Wno-unused-parameter on GCC/Clang. 2016-05-08 00:01:35 +00:00
pkg Add and build mimalloc at 07c6e60a5a3bd7de09e4a170cd97bafba59cfafd 2020-07-12 02:37:07 +00:00
res Chinese translation added. 2020-10-20 11:08:34 -04:00
src macOS: add NSOpenGLPFADoubleBuffer to NSOpenGLPixelFormatAttribute 2020-10-20 10:59:58 -04:00
test Show area of closed contour with SI units. 2020-06-23 02:39:57 +00: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 Travis: Build improvements and fixes (#751) 2020-10-20 09:39:26 +02:00
.gitmodules Add and build mimalloc at 07c6e60a5a3bd7de09e4a170cd97bafba59cfafd 2020-07-12 02:37:07 +00:00
.travis.yml Travis: update travis and macos build configs 2020-10-20 11:03:13 -04:00
CHANGELOG.md Updated changelog 2020-09-30 17:30:51 -04:00
CMakeLists.txt Travis: Build improvements and fixes (#751) 2020-10-20 09:39:26 +02:00
CONTRIBUTING.md Add a .clang-format file - not for bulk use! 2019-05-23 14:16:00 +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 and build mimalloc at 07c6e60a5a3bd7de09e4a170cd97bafba59cfafd 2020-07-12 02:37:07 +00:00
THIRD_PARTIES.txt Add a built-in Bitstream Vera Sans Roman font. 2019-02-11 11:03:47 +00:00
appveyor.yml Win32: when building with MSVC, require VS2015. 2020-05-10 12:20:21 +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 Snap Store

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.

Future official releases will appear in the stable channel.

Get it from the Snap Store

Or install from a terminal:

snap install --edge solvespace

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

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, 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 libflatbuffers-dev

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 32-bit SolveSpace as following:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw32.cmake \
         -DCMAKE_BUILD_TYPE=Release \
         -DFLATC=$(which flatc)
make

Or, build 64-bit SolveSpace as 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
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 extlib/flatbuffers extlib/q3d 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 license. It is possible to license SolveSpace for use in a commercial application; to do so, contact the developers.