-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
53 changed files
with
1,750 additions
and
7,142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,31 @@ | ||
| #  FLUX:: Immersive Documentation | ||
|
|
||
| ## Immersive | ||
|
|
||
| - [SPAT Revolution](spat-revolution/index.html) | ||
| - [IRCAM-Tools HEar](ircam-hear/index.html) | ||
|
|
||
| ## Analysis | ||
|
|
||
| - [FLUX:: Analyzer](analyzer/index.html) | ||
| - [Studio Session Analyzer](/studio-session-analyser/index.html) | ||
|
|
||
| ## Evo Modules | ||
|
|
||
| - [Evo Channel](/evo-channel/index.html) | ||
| - [Evo In](/evo-in/index.html) | ||
| - [Evo EQ](/evo-eq/index.html) | ||
| - [Evo Compressor](/evo-comp/index.html) | ||
| - [Evo Touch](/evo-touch/index.html) | ||
|
|
||
| ## Processing | ||
|
|
||
| - [Alchemist](/alchemist/index.html) | ||
| - [Bittersweet](/bittersweet/index.html) | ||
| - [Bittersweet Pro](/bittersweet-pro/index.html) | ||
| - [Elixir](/elixir/index.html) | ||
| - [Epure](/epure/index.html) | ||
| - [IRCAM-Tools Trax](/ircam-trax/index.html) | ||
| - [IRCAM-Tools Verb](/ircam-verb/index.html) | ||
| - [IRCAM-Tools Verb Session](/ircam-verb-session/index.html) | ||
| - [Pure Compressor](/pure-compressor/index.html) | ||
| - [Pure Dcompressor](/pure-dcompressor/index.html) | ||
| - [Pure Dexpander](/pure-dexpander/index.html) | ||
| - [Pure Expander](/pure-expander/index.html) | ||
| - [Pure Limiter](/pure-limiter/index.html) | ||
| - [Solera](/solera/index.html) | ||
| - [Stereo Tool](/stereotool/index.html) | ||
| - [Studio Session Plugins](/studio-session-plugins/index.html) | ||
| - [Syrah](/syrah/index.html) | ||
|
|
||
| ## Legacy | ||
|
|
||
| - [Elixir v3](/elixir-v3/index.html) | ||
| - [IRCAM-Tools Spat (Plugin)](/ircam-spat/index.html) | ||
| - [Jünger Level Magic](/junger-level-magic/index.html) | ||
| # FLUX:: Immersive Product Documentation | ||
|
|
||
| This repository host the documentation of all FLUX:: products. It uses quarto to generate the doc.flux.audio html pages as well as pdf documents. | ||
|
|
||
| ## Repository structure | ||
|
|
||
| `en_US` is where is stored the sources for the documentation. Each product has a dedicated folder which corresponds to a quarto project. See : [https://quarto.org/docs/projects/quarto-projects.html](https://quarto.org/docs/projects/quarto-projects.html). This folder also store at its root the **common files**: | ||
|
|
||
| + `_common.yaml` dictate the two main rendering format (html and pdf) | ||
| + `credits_*.qmd` are credit mentions that are common to several products. They are included in the `Credits.qmd`files of each project using the following syntax : {{< include myfile.qmd >}} . See [https://quarto.org/docs/authoring/includes.html](https://quarto.org/docs/authoring/includes.html) | ||
| + `fluxtemplate.tex` is the common latex style sheet. | ||
|
|
||
| Inside `en_US`, the `home` folder/project is a special project to handle the home page of the documentation (doc.flux.audio). | ||
|
|
||
| `scripts` is where some utility python scripts are stored. | ||
|
|
||
| + `img-checker.py` allows checking the image links from a file or a whole quarto project. As latex rendering for pdf crash if an image has a dead link, it is a good practice to use this script before rendering (as latex rendering is very time consuming). Simply invoke it with the following command: `python3 img-checker.py file_or_folder_to_test` | ||
|
|
||
| ## Local render | ||
|
|
||
| The documentation can be rendered locally per project by using the command `quarto render my_project` where `my_project` is the folder representing the quarto project. The files are then generated in the `.build/my_project` folder at the root of the directory. The folder `.build` is excluded from git. | ||
|
|
||
| The rendering of all the documentation can be done by using the `buildAll.bash` script at the root of the repository. | ||
|
|
||
| ## Online rendering | ||
|
|
||
| The generation of all the web pages and pdf files are handled by a GitHub job. The process happens on a push on the master branch. Beware that the process is very long, so be sure that the local render work first before pushing to master. **Obviously, branches should be used for new content or content improving.** | ||
|
|
||
| ## Rendering failure | ||
|
|
||
| If one rendering has failed (for a missing image for example), the generate files in `.build` as well as the LaTeX intermediary files store in the **project folder** (`en_US/my_project`) should be deleted before attempting a new render. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,3 @@ | ||
| # Credits | ||
|
|
||
| ### Project Manager and Designer: | ||
| Gaël Martinet | ||
|
|
||
| ### Application Development: | ||
| Gaël Martinet, Alexis Gentil, Bastien Prevosto, Anthony Belard, Maxence Grandidier, Siegfried Hand and Antoine Lorence. | ||
|
|
||
| ### FLUX:: DSP Design and Development: | ||
| Gaël Martinet, Maxence Grandidier and Lorcan Mc Donagh | ||
|
|
||
| ### Graphic design: | ||
| Nicolas Philippot | ||
|
|
||
| ### FLUX:: Framework development: | ||
| Gaël Martinet, Florie-Anne Lafaye, Alexis Gentil, Lorcan Mc Donagh, Bastien Prevosto, Anthony Belard, Siegfried Hand and Antoine Lorence | ||
|
|
||
| **Additional contributions:** | ||
| Vincent Carlier, Jean-Loup Pecquais, Nicolas Erard, Jean Cruypenynck, Pablo Arias, Samuel Tracol | ||
|
|
||
| ### FLUX:: Framework graphic engine: | ||
| Emmanuel Julien (GS lib) and Gaël Martinet | ||
|
|
||
| ### Additional libs: | ||
| * GS lib (Emmanuel Julien, Gael Martinet) | ||
| * ThorVG, Copyright (c) 2020 - 2023 notice for the ThorVG Project (see AUTHORS) | ||
| * r8brain free - Copyright (c) 2013-2023 Aleksey Vaneev | ||
| * LibJpeg - Copyright (c) 1991-2016, Thomas G. Lane, Guido Vollbeding | ||
| * libpng : | ||
| - Copyright (c) 1995-2023 The PNG Reference Library Authors. | ||
| - Copyright (c) 2018-2023 Cosmin Truta. | ||
| - Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson. | ||
| - Copyright (c) 1996-1997 Andreas Dilger. | ||
| - Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. | ||
|
|
||
| * Freetype 2 - Copyright (c) 2006-2023 by David Turner, Robert Wilhelm, and Werner Lemberg. | ||
| * Zlib - Copyright (c) 1995-2022 Jean-loup Gailly and Mark Adler | ||
| * bzip2 - Copyright (c) 1996-2010 Julian Seward <jseward@bzip.org> | ||
| * Boost - BSL-1.0 | ||
| * mimalloc - Copyright (c) 2018-2021 Microsoft Corporation, Daan Leijen | ||
| * ni-media - Copyright (c) 2022 Native Instruments | ||
| * pfft: | ||
| - Copyright (c) 2004 the University Corporation for Atmospheric Research ("UCAR") | ||
| - Copyright (c) 2013 Julien Pommier ( pommier@modartt.com ) | ||
| - Copyright (c) 2019 Hayati Ayguen ( h_ayguen@web.de ) | ||
| - Copyright (c) 2020 Dario Mambro ( dario.mambro@gmail.com ) | ||
|
|
||
| * pybind11 - Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> | ||
| * rtaudio - Copyright (c) 2001-2021 Gary P. Scavone | ||
| * rtmidi - Copyright (c) 2003-2021 Gary P. Scavone | ||
| * concurrentqueue - Copyright (c) 2013-2016, Cameron Desrochers. | ||
| * readerwriterqueue - Copyright (c) 2013-2021, Cameron Desrochers. | ||
| * assimp - Copyright (c) 2006-2021, assimp team | ||
| * enet - Copyright (c) 2002-2020 Lee Salzman | ||
| * fmt - Copyright (c) 2012 - present, Victor Zverovich and {fmt} contributors | ||
| * functions (Erik Rigtorp) - Copyright (c) 2015 Erik Rigtorp <erik@rigtorp.se> | ||
| * inplace_function - BSL-1.0 | ||
| * gtest - Copyright 2008, Google Inc. | ||
| * jsoncpp - Copyright (c) 2007-2010 Baptiste Lepilleur and The JsonCpp Authors | ||
| * libcurl - Copyright (c) 1996 - 2023, Daniel Stenberg, daniel@haxx.se, and many contributors | ||
| * magic_enum - Copyright (c) 2019 - 2023 Daniil Goncharov | ||
| * nanobench - Copyright (c) 2019-2023 Martin Leitner-Ankerl | ||
| * nlohmann_json - Copyright (c) 2013-2022 Niels Lohmann | ||
| * openddl - Copyright (c) 1999-2022 Eric Lengyel | ||
| * openvr - Copyright (c) 2015, Valve Corporation | ||
| * poly2tri - Copyright (c) 2009-2018, Poly2Tri Contributors | ||
| * pugixml - Copyright (c) 2006-2022 Arseny Kapoulkine | ||
| * rapidjson - Copyright (c) 2015 THL A29 Limited, a Tencent company, and Milo Yip. | ||
| * shared_recursive_mutex - Copyright (c) 2019 konanM | ||
| * sentry-native - Copyright (c) 2019 Sentry (https://sentry.io) and individual contributors. | ||
| * sqlite3 - Public Domain License | ||
| * sqlite_orm - Copyright (c) 2012-2023 Eugene Zakharov and others | ||
| * stb - Copyright (c) 2017 Sean Barrett | ||
| * utfcpp - Copyright 2006 Nemanja Trifunovic | ||
| * unqlite - Copyright (c) 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Symisc Systems, S.U.A.R.L [M.I.A.G Mrad Chems Eddine <chm@symisc.net>]. | ||
|
|
||
|
|
||
| ### And | ||
| thanks to all fantastic testers... | ||
|
|
||
|
|
||
| ### FLUX:: Special Thanks to: | ||
| Alain, Yves, Bruno and Claude for helping to shape our minds over the years. | ||
|
|
||
|
|
||
| ### Published by FLUX:: | ||
| ``` | ||
| http://wwww.flux.audio | ||
| Copyright (c) 2024 HARMAN International, All rights reserved. | ||
| FLUX:: is a trademark of HARMAN International. | ||
| ``` | ||
|
|
||
| ### FLUX:: | ||
| http://wwww.flux.audio | ||
|
|
||
| COPYRIGHT (c) 2024, HARMAN INTERNATIONAL. ALL RIGHTS RESERVED. | ||
| {{< include ../credits_plugins.qmd >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.