Giter Site home page Giter Site logo

theslowgrowth / frut Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mcmartin/frut

0.0 0.0 0.0 4.7 MB

Building JUCE projects using CMake made easy

Home Page: https://frut.readthedocs.io

License: GNU General Public License v3.0

CMake 84.22% C 1.87% C++ 12.16% Makefile 1.31% C# 0.45%

frut's Introduction

Contributor Covenant Code of Conduct AppVeyor build status Azure Pipelines build status Travis CI build status Documentation status

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

Table of Contents

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:

Requirements

  • CMake, version 3.4 minimum
  • JUCE, version 4.2.0 minimum

Supported Projucer exporters

Reprojucer.cmake and Jucer2Reprojucer support the following Projucer exporters (also known as "export targets"):

SupportedExporterMissing features
✔️Xcode (MacOSX) 8 unsupported Xcode exporter settings and
2 unsupported Xcode (MacOSX) exporter settings
Xcode (iOS) 8 unsupported Xcode exporter settings
✔️Visual Studio 2019 1 unsupported Visual Studio exporter setting
✔️Visual Studio 2017
✔️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:

<root>
├── FRUT/
├── JUCE/
└── MyGreatProject/
    ├── Source/
    └── MyGreatProject.jucer

We first build and install FRUT with CMake:

$ cd <root>/FRUT/

$ mkdir build && cd build/

$ cmake .. -DCMAKE_INSTALL_PREFIX=../prefix -DJUCE_ROOT=../../JUCE
...
-- Configuring done
-- Generating done
-- Build files have been written to: <root>/FRUT/build

$ cmake --build . --target install
...

If it fails to build and install, please report the problem by writing a new comment on the following GitHub issue: McMartin#512.

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

$ cd <root>/MyGreatProject/

$ ../FRUT/prefix/FRUT/bin/Jucer2Reprojucer MyGreatProject.jucer ../FRUT/prefix/FRUT/cmake/Reprojucer.cmake

<root>/MyGreatProject/CMakeLists.txt has been successfully generated.

Now we can build MyGreatProject using CMake:

$ cd <root>/MyGreatProject/

$ mkdir build && cd build/

$ cmake .. -G<generator>
...
-- Configuring done
-- Generating done
-- Build files have been written to: <root>/MyGreatProject/build

$ cmake --build .
...

<generator> 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 and 2017 (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:


Alain Martin

💻 👀 📖

Matthieu Talbot

👀 💻 🐛

Florian Goltz

💻

Fabien Roussel

🐛 👀

Xavier Jouvenot

🐛 👀

Nikolai Wuttke

👀

Dominik Grzelak

🐛

Dennis Scheffer

🐛 💻

Scott Wheeler

💻 🐛

Iqra Shahzad

🐛

Romain Clement

🐛

Jerry Chan

🐛 👀

Frank Lange

🐛

Johannes Elliesen

🐛 💻

License

GNU General Public License

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.

frut's People

Contributors

dscheffer avatar fgo-ableton avatar gitter-badger avatar gonzaloflirt avatar martylake avatar mcmartin avatar scotchi avatar theslowgrowth avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.