0.4.0 • Published 10 months ago

@opendesign/engine-source v0.4.0

Weekly downloads
-
License
-
Repository
-
Last release
10 months ago

Open Design Engine

The Open Design Engine processes and renders designs and provides interface to query and manipulate their contents.

How to build

  1. Make sure you have installed CMake, vcpkg, and a C++ compiler (e.g. Visual Studio, XCode, or g++).
  2. Linux & Mac only: Using APT or Homebrew, install automake autoconf autoconf-archive
  3. (Optional) I would recommend setting your vcpkg directory as persistent system variable VCPKG_ROOT. If you do, you may omit the -DCMAKE_TOOLCHAIN_FILE option in the following step.
  4. Generate CMake build. There are presets available (list them with cmake --list-presets), for example
    • cmake --preset win64 -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
  5. Build generated project, e.g. cmake --build build/win64

Maintainer guidelines

  • The version of ODE is defined in vcpkg.json and automatically parsed from this file for other purposes.
  • Some committed files are machine-generated. These are marked as such at the beginning. Do not modify any generated files by hand and make sure they are up-to-date before committing.
  • All commit messages must be capitalized.
  • You may run repo-check.py to check if the repository content is in a state that can be committed.

Project module hierarchy

Open Design Engine architecture diagram