Skip to content

Commit 8aed6ae

Browse files
committed
Start a file for setup instructions
The quick start assumes a system with the necessary dependencies in place, but unlike the old-school BRL-CAD build we can't stand up these software stacks without a sizable set of development packages in place. Need to collect the instructions on how to do that somewhere, since we aren't aiming to bootstrap things like fontconfig/freetype or XCB X11.
1 parent ab5a8dd commit 8aed6ae

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

INSTALL.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# bext - Installation
2+
3+
For building all of the projects present in this repository, you will need Git, CMake, a modern C/C++ compiler and some support libraries installed on your operating system. If you want flex and bison you'll also need a working Autotools stack on non-Windows platforms.
4+
5+
# Ubuntu Linux
6+
7+
Basic tools needed for all configurations:
8+
```
9+
sudo apt install git cmake gcc g++
10+
```
11+
12+
For Tk you'll need basic X11 libraries:
13+
```
14+
sudo apt install libfontconfig1-dev libfreetype6-dev xserver-xorg-dev libx11-dev libxi-dev libxext-dev
15+
```
16+
17+
For Qt, Appleseed and OSPRay you'll need Python
18+
```
19+
sudo apt install libpython3-dev
20+
```
21+
22+
For Qt you'll also need (in addition to the above) the XCB packages (see https://doc.qt.io/qt-6/linux-requirements.html)
23+
```
24+
sudo apt install libx11-xcb-dev libxfixes-dev libxrender-dev libxcb1-dev libxcb-cursor-dev libxcb-glx0-dev libxcb-keysyms1-dev libxcb-image0-dev libxcb-shm0-dev libxcb-icccm4-dev libxcb-sync-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-randr0-dev libxcb-render-util0-dev libxcb-util-dev libxcb-xinerama0-dev libxcb-xkb-dev libxkbcommon-dev libxkbcommon-x11-dev
25+
```
26+
27+
For OSPRay you'll need m4, and for the ISPC compiler used by OSPRay you'll need the gcc multilib packages:
28+
```
29+
sudo apt install m4 gcc-multilib g++-multilib
30+
```
31+
32+
If you don't want to build flex and bison for the OSPRay/Appleseed stacks you can also install those:
33+
```
34+
sudo apt install flex bison
35+
```
36+
37+
If you do want to build them, install the Autotools stack:
38+
```
39+
sudo apt-get install autotools-dev autoconf
40+
```
41+
42+
# Windows
43+
44+
Windows will need some variety of Python installed for Qt/Appleseed/OSPRay.
45+
46+
# OSX
47+
48+
XCode
49+
50+
What else? - TODO
51+

0 commit comments

Comments
 (0)