Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/McMartin/FRUT

Building JUCE projects using CMake made easy
https://github.com/McMartin/FRUT

build-tool cmake juce juce-framework

Last synced: 3 months ago
JSON representation

Building JUCE projects using CMake made easy

Awesome Lists containing this project

README 

        
|Code_of_Conduct| |AppVeyor| |Azure_Pipelines| |Read_the_Docs|



.. image:: FRUT.svg

  :target: https://github.com/McMartin/FRUT

  :alt: FRUT



FRUT makes it easy to build `JUCE`_ projects using `CMake`_ instead of `Projucer`_. It

enables more flexibility in project architecture, simplified CI setup, and easier

integration with other JUCE and non-JUCE projects. Converting an existing JUCE project to

FRUT is easy, and you don't need to be a CMake expert to use it!



**In short**



- *Requirements*



  - CMake (3.4 minimum, or `higher depending on the target platform

    <#supported-projucer-exporters>`__)

  - JUCE (4.2.0 minimum)



- *Supported platforms*



  - iOS

  - Linux

  - macOS

  - Windows (MSVC and MinGW)



- *Documentation* - https://frut.readthedocs.io

- *Contributing*



  - Contributions are welcome! See `CONTRIBUTING.md`_ for more details.

  - `All contributors are recognized <#contributors>`__



**Table of Contents**



.. contents::

  :local:

  :backlinks: none



Background

----------



`JUCE`_ comes with its own project generation tool, `Projucer`_, which is very useful when

starting a JUCE project. However, Projucer doesn't scale well when you want to make some

aspects of your project configurable, when you want to add external libraries, when you

want to use Continuous Integration, or when you want to manage several projects at once.



FRUT was created to overcome these limitations, while making it very easy to migrate an

existing JUCE project that uses Projucer. Since FRUT is based on `CMake`_, you also get

access to many great features of CMake, including `testing

`__ and `packaging

`__ utilities.



Contents

--------



FRUT currently contains:



- ``Jucer2CMake``, a console application that converts ``.jucer`` project files into

  ready-to-use ``CMakeLists.txt`` files,



- ``Reprojucer.cmake``, a CMake module that provides high-level functions to reproduce

  how a JUCE project is defined in Projucer,



- several ``CMakeLists.txt`` files generated from existing ``.jucer`` project files,

  including:



  - ``examples`` and ``extras`` projects from `JUCE 4.2.0`_ (in `generated/JUCE-4.2.0`_)

  - ``examples`` and ``extras`` projects from `JUCE 4.3.1`_ (in `generated/JUCE-4.3.1`_)

  - ``examples`` and ``extras`` projects from `JUCE 5.0.0`_ (in `generated/JUCE-5.0.0`_)

  - ``examples`` and ``extras`` projects from `JUCE 5.2.1`_ (in `generated/JUCE-5.2.1`_)

  - ``examples`` and ``extras`` projects from `JUCE 5.3.1`_ (in `generated/JUCE-5.3.1`_)

  - ``examples`` and ``extras`` projects from `JUCE 5.4.3`_ (in `generated/JUCE-5.4.3`_)

  - ``examples`` and ``extras`` projects from `JUCE 5.4.7`_ (in `generated/JUCE-5.4.7`_)

  - ``examples`` and ``extras`` projects from `JUCE 6.0.5`_ (in `generated/JUCE-6.0.5`_)

  - ``examples`` and ``extras`` projects from `JUCE 6.1.6`_ (in `generated/JUCE-6.1.6`_)

  - ``examples`` and ``extras`` projects from `JUCE 7.0.7`_ (in `generated/JUCE-7.0.7`_)



Requirements

------------



- CMake, version 3.4 minimum

- JUCE, version 4.2.0 minimum



Supported Projucer exporters

----------------------------



``Jucer2CMake`` and ``Reprojucer.cmake`` support the following Projucer exporters (also

known as "export targets"):



.. raw:: html



  

  

    SupportedExporterCMake requirements and optionsMissing features

  

  

    βœ”οΈXcode (macOS)

      4 unsupported Xcode exporter settings

    

    βœ”οΈXcode (iOS)version 3.14 minimum
-G Xcode -DCMAKE_SYSTEM_NAME=iOS


    βœ”οΈVisual Studio 2022version 3.21 minimum

      3 unsupported Visual Studio exporter settings

    

    βœ”οΈVisual Studio 2019version 3.14 minimum

    βœ”οΈVisual Studio 2017version 3.7 minimum
(3.13.3 when VSΒ 2019 is installed)

    βœ”οΈVisual Studio 2015

    βœ”οΈVisual Studio 2013

    βœ”οΈLinux Makefile

    ❌Android

    βœ”οΈCode::BlocksΒ (Windows)

    βœ”οΈCode::BlocksΒ (Linux)

  

  



Documentation

-------------



You can read the documentation of FRUT on Read the Docs: https://frut.readthedocs.io



Getting started

---------------



Let's consider that you have a copy of `JUCE`_, a copy of `FRUT`_ and a JUCE project

called ``MyGreatProject`` following this folder structure: ::



  

  β”œβ”€β”€ FRUT/

  β”œβ”€β”€ JUCE/

  └── MyGreatProject/

      β”œβ”€β”€ Source/

      └── MyGreatProject.jucer



We first build and install FRUT with CMake: ::



  $ cd /FRUT/



  $ mkdir build && cd build/



  $ cmake .. -DCMAKE_INSTALL_PREFIX="../prefix" -DJUCE_ROOT="../../JUCE"

  ...

  -- Configuring done

  -- Generating done

  -- Build files have been written to: /FRUT/build



  $ cmake --build . --target install

  # or

  $ cmake --build . --target install --parallel  # with CMake 3.12 or later

  ...



If it fails to build and install, please report the problem by creating a new issue on

GitHub: https://github.com/McMartin/FRUT/issues/new.



Then we convert ``MyGreatProject.jucer`` to a new ``CMakeLists.txt`` file: ::



  $ cd /MyGreatProject/



  $ ../FRUT/prefix/FRUT/bin/Jucer2CMake reprojucer MyGreatProject.jucer ../FRUT/prefix/FRUT/cmake/Reprojucer.cmake



  /MyGreatProject/CMakeLists.txt has been successfully generated.



Now we can build ``MyGreatProject`` using CMake: ::



  $ cd /MyGreatProject/



  $ mkdir build && cd build/



  $ cmake .. -G

  ...

  -- Configuring done

  -- Generating done

  -- Build files have been written to: /MyGreatProject/build



  $ cmake --build .

  # or

  $ cmake --build . -- -parallelizeTargets  # when  is Xcode

  # or

  $ cmake --build . --parallel  # with CMake 3.12 or later

  ...



```` can be one of many `CMake Generators`_ supported by your platform,

including Ninja, NMake Makefiles (on Windows), Unix Makefiles (on Linux and macOS), Visual

Studio 2013, 2015, 2017, 2019 and 2022 (on Windows), and Xcode (on macOS).



Contributing

------------



Contributions to FRUT are very welcomed and you can contribute even if you don't know

anything about CMake. See the `CONTRIBUTING.md`_ file for more details.



Contributors

------------



FRUT follows the `all-contributors`_ specification and is brought to you by these awesome

contributors:



.. raw:: html



  

  

  

    

      
Alain Martin

      


      πŸ’»

      πŸ‘€

      πŸ“–

    

    

      
Matthieu Talbot

      


      πŸ‘€

      πŸ’»

      πŸ›

    

    

      
Florian Goltz

      


      πŸ’»

    

    

      
Fabien Roussel

      


      πŸ›

      πŸ‘€

    

    

      
Xavier Jouvenot

      


      πŸ›

      πŸ‘€

    

    

      
Nikolai Wuttke

      


      πŸ‘€

    

  

  

    

      
Dominik Grzelak

      


      πŸ›

    

    

      
Dennis Scheffer

      


      πŸ›

      πŸ’»

    

    

      
Scott Wheeler

      


      πŸ’»

      πŸ›

    

    

      
Iqra Shahzad

      


      πŸ›

    

    

      
Romain Clement

      


      πŸ›

    

    

      
Stijn Frishert

      


      πŸ›

    

  

  

    

      
Jerry Chan

      


      πŸ›

      πŸ‘€

    

    

      
Frank Lange

      


      πŸ›

    

    

      
Johannes Elliesen

      


      πŸ›

      πŸ’»

    

    

      
David Holland

      


      πŸ’»

    

    

      
Dimitri Sudell

      


      πŸ›

      πŸ‘€

    

    

      
Dan Raviv

      


      πŸ›

      πŸ‘€

    

  

  

    

      
Rory Walsh

      


      πŸ›

    

    

      
Eyal Amir

      


      πŸ›

    

    

      
Michael Hetrick

      


      πŸ›

    

    

      
Alex

      


      πŸ’»

      πŸ‘€

    

    

      
Alexey Romanoff

      


      πŸ›

    

    

      
Benedikt Adams

      


      πŸ›

    

  

  

    

      
Steve Baker

      


      πŸ›

    

    

      
David Crome

      


      πŸ›

    

    

      
JF Castel-Branco

      


      πŸ›

    

    

      
Butch Warns

      


      πŸ›

    

    

      
Suganthan BC

      


      πŸ›

    

    

      
ThiΓ©baud Fuchs

      


      πŸ›

      πŸ’»

    

  

  

    

      
Hayden Setlik

      


      πŸ›

    

    

      
Adrian Ostrowski

      


      πŸ’»

    

    

      
NaΓ―l Perreau

      


      πŸ›

    

    

    

    

    

    

    

  

  

  



License

-------



|GPLv3|



FRUT is free software: you can redistribute it and/or modify it under the terms of the GNU

General Public License as published by the Free Software Foundation, either version 3 of

the License, or (at your option) any later version.



FRUT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without

even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

`LICENSE`_ file for more details.



.. |Code_of_Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Contributor%20Covenant-blue.svg?style=flat

  :target: CODE_OF_CONDUCT.md

  :alt: Contributor Covenant Code of Conduct



.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/McMartin/frut?branch=main&svg=true

  :target: https://ci.appveyor.com/project/McMartin/frut

  :alt: AppVeyor build status



.. |Azure_Pipelines| image:: https://dev.azure.com/McMartin/FRUT/_apis/build/status/McMartin.FRUT?branchName=main

  :target: https://dev.azure.com/McMartin/FRUT/_build?definitionId=2

  :alt: Azure Pipelines build status



.. |Read_the_Docs| image:: https://readthedocs.org/projects/frut/badge/?version=latest

  :target: https://frut.readthedocs.io

  :alt: Documentation status



.. |GPLv3| image:: https://www.gnu.org/graphics/gplv3-127x51.png

  :target: https://www.gnu.org/licenses/gpl.html

  :alt: GNU General Public License



.. _CONTRIBUTING.md: CONTRIBUTING.md

.. _LICENSE: LICENSE

.. _generated/JUCE-4.2.0: generated/JUCE-4.2.0

.. _generated/JUCE-4.3.1: generated/JUCE-4.3.1

.. _generated/JUCE-5.0.0: generated/JUCE-5.0.0

.. _generated/JUCE-5.2.1: generated/JUCE-5.2.1

.. _generated/JUCE-5.3.1: generated/JUCE-5.3.1

.. _generated/JUCE-5.4.3: generated/JUCE-5.4.3

.. _generated/JUCE-5.4.7: generated/JUCE-5.4.7

.. _generated/JUCE-6.0.5: generated/JUCE-6.0.5

.. _generated/JUCE-6.1.6: generated/JUCE-6.1.6

.. _generated/JUCE-7.0.7: generated/JUCE-7.0.7



.. _CMake Generators: https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html

.. _CMake: https://cmake.org

.. _FRUT: https://github.com/McMartin/FRUT

.. _JUCE 4.2.0: https://github.com/juce-framework/JUCE/tree/4.2.0

.. _JUCE 4.3.1: https://github.com/juce-framework/JUCE/tree/4.3.1

.. _JUCE 5.0.0: https://github.com/juce-framework/JUCE/tree/5.0.0

.. _JUCE 5.2.1: https://github.com/juce-framework/JUCE/tree/5.2.1

.. _JUCE 5.3.1: https://github.com/juce-framework/JUCE/tree/5.3.1

.. _JUCE 5.4.3: https://github.com/juce-framework/JUCE/tree/5.4.3

.. _JUCE 5.4.7: https://github.com/juce-framework/JUCE/tree/5.4.7

.. _JUCE 6.0.5: https://github.com/juce-framework/JUCE/tree/6.0.5

.. _JUCE 6.1.6: https://github.com/juce-framework/JUCE/tree/6.1.6

.. _JUCE 7.0.7: https://github.com/juce-framework/JUCE/tree/7.0.7

.. _JUCE: https://github.com/juce-framework/JUCE

.. _Projucer: https://juce.com/discover/projucer

.. _all-contributors: https://github.com/all-contributors/all-contributors