Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.81 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.81 KB
Raw

Lagrange Example Project

An example project that uses Lagrange. To get started, click on "Use this template" on GitHub, then go through the steps below, changing paths to your project name.

Usage

  1. Requirements

    • CMake 3.20 or later. On Unix, CMake installed from apt can be outdated. Check with cmake --version.
    • Command line (Unix) or Powershell/Git Bash (Windows).

  2. Clone the repository:

    git clone https://github.com/adobe/lagrange-example-project.git

  3. Setup build:

    cd <lagrange-example-project>
mkdir build
cd build
cmake ..

    By default, this will generate a Visual Studio project on Windows, and Unix Makefiles on OSX and Linux. If you wish to use XCode on Mac, use cmake -G "Xcode" .. instead.

  4. Select Lagrange features

    You can browse Lagrange options to enable in Lagrange's LagrangeOptions.cmake.sample or by running cmake-gui .. Once you're done, press Configure and then Generate. In your project's CMakeLists.txt, include the modules you want by calling lagrange_include_modules() after including Lagrange.

  5. Build

    cmake --build .

    Or open the Visual Studio/XCode project with cmake --open .

Documentation

Please check the docs/ folder for instructions on how to compile Doxygen documentation for this project.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This example project is licensed under the MIT license. See LICENSE for more information.